all: regenerate APIs
Change-Id: Ic040b76d775b6bf7b71e0b93ff8d442419483b96
Reviewed-on: https://code-review.googlesource.com/13531
Reviewed-by: Jonathan Amsterdam <jba@google.com>
diff --git a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
index 26acf6f..d59fbf6 100644
--- a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
+++ b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
@@ -1,55 +1,37 @@
{
- "discoveryVersion": "v1",
- "ownerName": "Google",
"version_module": "True",
"resources": {
"ampUrls": {
"methods": {
"batchGet": {
- "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"
},
- "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format)."
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "BatchGetAmpUrlsResponse"
+ },
+ "parameters": {},
+ "flatPath": "v1/ampUrls:batchGet",
+ "id": "acceleratedmobilepageurl.ampUrls.batchGet",
+ "path": "v1/ampUrls:batchGet"
}
}
}
},
"parameters": {
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"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",
@@ -61,25 +43,26 @@
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 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",
@@ -92,13 +75,12 @@
"json",
"media",
"proto"
- ],
- "type": "string"
+ ]
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"key": {
"location": "query",
@@ -109,30 +91,25 @@
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"schemas": {
- "BatchGetAmpUrlsResponse": {
- "properties": {
- "ampUrls": {
- "description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once.",
- "type": "array",
- "items": {
- "$ref": "AmpUrl"
- }
- },
- "urlErrors": {
- "description": "The errors for requested URLs that have no AMP URL.",
- "type": "array",
- "items": {
- "$ref": "AmpUrlError"
- }
- }
- },
- "id": "BatchGetAmpUrlsResponse",
- "description": "Batch AMP URL response.",
- "type": "object"
- },
"AmpUrl": {
"description": "AMP URL response for a requested URL.",
"type": "object",
@@ -161,6 +138,7 @@
"type": "string"
},
"errorCode": {
+ "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.",
@@ -177,8 +155,7 @@
"URL_IS_VALID_AMP",
"URL_IS_INVALID_AMP"
],
- "description": "The error code of an API call.",
- "type": "string"
+ "description": "The error code of an API call."
},
"originalUrl": {
"description": "The original non-AMP URL.",
@@ -188,6 +165,7 @@
"id": "AmpUrlError"
},
"BatchGetAmpUrlsRequest": {
+ "description": "AMP URL request for a batch of URLs.",
"type": "object",
"properties": {
"urls": {
@@ -198,7 +176,6 @@
}
},
"lookupStrategy": {
- "type": "string",
"enumDescriptions": [
"FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in\nthe index. Any request URL not found in the index is crawled in realtime\nto validate if there is a corresponding AMP URL. This strategy has higher\ncoverage but with extra latency introduced by realtime crawling. This is\nthe default strategy. Applications using this strategy should set higher\nHTTP timeouts of the API calls.",
"IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found\nin index. For applications which need low latency use of IN_INDEX_DOC\nstrategy is recommended."
@@ -207,18 +184,39 @@
"FETCH_LIVE_DOC",
"IN_INDEX_DOC"
],
- "description": "The lookup_strategy being requested."
+ "description": "The lookup_strategy being requested.",
+ "type": "string"
}
},
- "id": "BatchGetAmpUrlsRequest",
- "description": "AMP URL request for a batch of URLs."
+ "id": "BatchGetAmpUrlsRequest"
+ },
+ "BatchGetAmpUrlsResponse": {
+ "description": "Batch AMP URL response.",
+ "type": "object",
+ "properties": {
+ "ampUrls": {
+ "description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once.",
+ "type": "array",
+ "items": {
+ "$ref": "AmpUrl"
+ }
+ },
+ "urlErrors": {
+ "description": "The errors for requested URLs that have no AMP URL.",
+ "type": "array",
+ "items": {
+ "$ref": "AmpUrlError"
+ }
+ }
+ },
+ "id": "BatchGetAmpUrlsResponse"
}
},
- "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://acceleratedmobilepageurl.googleapis.com/",
"kind": "discovery#restDescription",
@@ -229,8 +227,10 @@
"ownerDomain": "google.com",
"name": "acceleratedmobilepageurl",
"batchPath": "batch",
+ "id": "acceleratedmobilepageurl:v1",
"revision": "20170504",
"documentationLink": "https://developers.google.com/amp/cache/",
- "id": "acceleratedmobilepageurl:v1",
- "title": "Accelerated Mobile Pages (AMP) URL API"
+ "title": "Accelerated Mobile Pages (AMP) URL API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
index 4ae64ac..33fb0d1 100644
--- a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
+++ b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
@@ -1,45 +1,454 @@
{
- "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.",
- "basePath": "",
- "revision": "20170509",
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/guides/client-access/",
- "id": "adexchangebuyer2:v2beta1",
- "discoveryVersion": "v1",
- "version_module": "True",
"schemas": {
- "AddDealAssociationRequest": {
- "description": "A request for associating a deal and a creative.",
+ "CreativeDealAssociation": {
+ "description": "The association between a creative and a deal.",
+ "type": "object",
+ "properties": {
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
+ "type": "string"
+ },
+ "dealsId": {
+ "description": "The externalDealId for the deal associated with the creative.",
+ "type": "string"
+ }
+ },
+ "id": "CreativeDealAssociation"
+ },
+ "Creative": {
+ "description": "A creative and its classification data.",
+ "type": "object",
+ "properties": {
+ "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."
+ },
+ "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": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "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."
+ },
+ "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": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "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": {
+ "type": "string",
+ "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"
+ ]
+ },
+ "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."
+ },
+ "video": {
+ "$ref": "VideoContent",
+ "description": "A video creative."
+ },
+ "servingRestrictions": {
+ "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
+ "type": "array",
+ "items": {
+ "$ref": "ServingRestriction"
+ }
+ }
+ },
+ "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": {
- "description": "The association between a creative and a deal that should be added.",
- "$ref": "CreativeDealAssociation"
+ "$ref": "CreativeDealAssociation",
+ "description": "The association between a creative and a deal that should be removed."
}
},
- "id": "AddDealAssociationRequest"
+ "id": "RemoveDealAssociationRequest"
+ },
+ "Client": {
+ "type": "object",
+ "properties": {
+ "entityName": {
+ "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the client buyer.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined client status.",
+ "A client that is currently disabled.",
+ "A client that is currently active."
+ ],
+ "enum": [
+ "CLIENT_STATUS_UNSPECIFIED",
+ "DISABLED",
+ "ACTIVE"
+ ]
+ },
+ "entityType": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string",
+ "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
+ "format": "int64"
+ }
+ },
+ "id": "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."
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "id": "Correction"
},
"ListDealAssociationsResponse": {
+ "description": "A response for listing creative and deal associations",
+ "type": "object",
"properties": {
"associations": {
- "description": "The list of associations.",
"type": "array",
"items": {
"$ref": "CreativeDealAssociation"
- }
+ },
+ "description": "The list of associations."
},
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
"type": "string"
}
},
- "id": "ListDealAssociationsResponse",
- "description": "A response for listing creative and deal associations",
+ "id": "ListDealAssociationsResponse"
+ },
+ "AddDealAssociationRequest": {
+ "properties": {
+ "association": {
+ "$ref": "CreativeDealAssociation",
+ "description": "The association between a creative and a deal that should be added."
+ }
+ },
+ "id": "AddDealAssociationRequest",
+ "description": "A request for associating a deal and a creative.",
"type": "object"
},
+ "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 +461,8 @@
}
},
"reason": {
+ "description": "The categorized reason for disapproval.",
+ "type": "string",
"enumDescriptions": [
"The length of the image animation is longer than allowed.",
"The click through URL doesn't work properly.",
@@ -243,30 +654,15 @@
"MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
"PERSONAL_LOANS",
"UNSUPPORTED_FLASH_CONTENT"
- ],
- "description": "The categorized reason for disapproval.",
- "type": "string"
+ ]
}
},
"id": "Disapproval"
},
- "StopWatchingCreativeRequest": {
- "id": "StopWatchingCreativeRequest",
- "description": "A request for stopping notifications for changes to creative Status.",
- "type": "object",
- "properties": {}
- },
"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": {
- "type": "array",
- "items": {
- "$ref": "Disapproval"
- },
- "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod."
- },
"contexts": {
"description": "The contexts for the restriction.",
"type": "array",
@@ -275,18 +671,25 @@
}
},
"status": {
+ "enumDescriptions": [
+ "The status is not known.",
+ "The ad was disapproved in this context.",
+ "The ad is pending review in this context."
+ ],
"enum": [
"STATUS_UNSPECIFIED",
"DISAPPROVAL",
"PENDING_REVIEW"
],
"description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).",
- "type": "string",
- "enumDescriptions": [
- "The status is not known.",
- "The ad was disapproved in this context.",
- "The ad is pending review in this context."
- ]
+ "type": "string"
+ },
+ "disapprovalReasons": {
+ "type": "array",
+ "items": {
+ "$ref": "Disapproval"
+ },
+ "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod."
}
},
"id": "ServingRestriction"
@@ -295,11 +698,6 @@
"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": {
- "type": "integer",
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32"
- },
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
@@ -309,6 +707,11 @@
"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"
@@ -320,6 +723,7 @@
"id": "Empty"
},
"WatchCreativeRequest": {
+ "id": "WatchCreativeRequest",
"description": "A request for watching changes to creative Status.",
"type": "object",
"properties": {
@@ -327,18 +731,12 @@
"description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.",
"type": "string"
}
- },
- "id": "WatchCreativeRequest"
+ }
},
"AppContext": {
- "description": "@OutputOnly The app type the restriction applies to for mobile device.",
"type": "object",
"properties": {
"appTypes": {
- "enumDescriptions": [
- "Native app context.",
- "Mobile web app context."
- ],
"description": "The app types this restriction applies to.",
"type": "array",
"items": {
@@ -347,70 +745,15 @@
"WEB"
],
"type": "string"
- }
+ },
+ "enumDescriptions": [
+ "Native app context.",
+ "Mobile web app context."
+ ]
}
},
- "id": "AppContext"
- },
- "NativeContent": {
- "description": "Native content for a creative.",
- "type": "object",
- "properties": {
- "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": {
- "type": "string",
- "description": "A long description of the ad."
- },
- "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": {
- "description": "A smaller image, for the advertiser's logo.",
- "$ref": "Image"
- },
- "priceDisplayText": {
- "description": "The price of the promoted app including currency info.",
- "type": "string"
- },
- "clickTrackingUrl": {
- "description": "The URL to use for click tracking.",
- "type": "string"
- },
- "image": {
- "$ref": "Image",
- "description": "A large image."
- },
- "advertiserName": {
- "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
- "type": "string"
- },
- "storeUrl": {
- "description": "The URL to the app store to purchase/download the promoted app.",
- "type": "string"
- },
- "headline": {
- "description": "A short title for the ad.",
- "type": "string"
- }
- },
- "id": "NativeContent"
+ "id": "AppContext",
+ "description": "@OutputOnly The app type the restriction applies to for mobile device."
},
"ListClientsResponse": {
"type": "object",
@@ -429,16 +772,71 @@
},
"id": "ListClientsResponse"
},
+ "NativeContent": {
+ "description": "Native content for a creative.",
+ "type": "object",
+ "properties": {
+ "priceDisplayText": {
+ "description": "The price of the promoted app including currency info.",
+ "type": "string"
+ },
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
+ "type": "string"
+ },
+ "image": {
+ "$ref": "Image",
+ "description": "A large image."
+ },
+ "advertiserName": {
+ "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
+ "type": "string"
+ },
+ "storeUrl": {
+ "type": "string",
+ "description": "The URL to the app store to purchase/download the promoted app."
+ },
+ "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"
+ },
"SecurityContext": {
- "id": "SecurityContext",
"description": "@OutputOnly A security context.",
"type": "object",
"properties": {
"securities": {
- "enumDescriptions": [
- "Matches impressions that require insecure compatibility.",
- "Matches impressions that require SSL compatibility."
- ],
"description": "The security types in this context.",
"type": "array",
"items": {
@@ -447,9 +845,35 @@
"SSL"
],
"type": "string"
- }
+ },
+ "enumDescriptions": [
+ "Matches impressions that require insecure compatibility.",
+ "Matches impressions that require SSL compatibility."
+ ]
}
- }
+ },
+ "id": "SecurityContext"
+ },
+ "HtmlContent": {
+ "type": "object",
+ "properties": {
+ "width": {
+ "description": "The width of the HTML snippet in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "snippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page.",
+ "type": "string"
+ },
+ "height": {
+ "description": "The height of the HTML snippet in pixels.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "HtmlContent",
+ "description": "HTML content for a creative."
},
"ListCreativesResponse": {
"description": "A response for listing creatives.",
@@ -463,52 +887,35 @@
}
},
"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"
+ "type": "string",
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results."
}
},
"id": "ListCreativesResponse"
},
- "HtmlContent": {
- "type": "object",
- "properties": {
- "height": {
- "description": "The height of the HTML snippet in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "width": {
- "description": "The width of the HTML snippet in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "snippet": {
- "description": "The HTML snippet that displays the ad when inserted in the web page.",
- "type": "string"
- }
- },
- "id": "HtmlContent",
- "description": "HTML content for a creative."
- },
"ServingContext": {
"description": "The serving context for this restriction.",
"type": "object",
"properties": {
+ "appType": {
+ "$ref": "AppContext",
+ "description": "Matches impressions for a particular app type."
+ },
"securityType": {
- "description": "Matches impressions for a particular security type.",
- "$ref": "SecurityContext"
+ "$ref": "SecurityContext",
+ "description": "Matches impressions for a particular security type."
},
"platform": {
- "$ref": "PlatformContext",
- "description": "Matches impressions coming from a particular platform."
+ "description": "Matches impressions coming from a particular platform.",
+ "$ref": "PlatformContext"
},
"location": {
"$ref": "LocationContext",
"description": "Matches impressions coming from users *or* publishers in a specific\nlocation."
},
"auctionType": {
- "description": "Matches impressions for a particular auction type.",
- "$ref": "AuctionContext"
+ "$ref": "AuctionContext",
+ "description": "Matches impressions for a particular auction type."
},
"all": {
"enumDescriptions": [
@@ -519,10 +926,6 @@
],
"description": "Matches all contexts.",
"type": "string"
- },
- "appType": {
- "$ref": "AppContext",
- "description": "Matches impressions for a particular app type."
}
},
"id": "ServingContext"
@@ -531,11 +934,6 @@
"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"
@@ -544,13 +942,16 @@
"description": "Image height in pixels.",
"format": "int32",
"type": "integer"
+ },
+ "width": {
+ "description": "Image width in pixels.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "Image"
},
"Reason": {
- "id": "Reason",
- "description": "A specific filtering status and how many times it occurred.",
"type": "object",
"properties": {
"status": {
@@ -563,10 +964,11 @@
"format": "int64",
"type": "string"
}
- }
+ },
+ "id": "Reason",
+ "description": "A specific filtering status and how many times it occurred."
},
"VideoContent": {
- "description": "Video content for a creative.",
"type": "object",
"properties": {
"videoUrl": {
@@ -574,17 +976,13 @@
"type": "string"
}
},
- "id": "VideoContent"
+ "id": "VideoContent",
+ "description": "Video content for a creative."
},
"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"
@@ -593,6 +991,11 @@
"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"
}
},
"id": "ClientUserInvitation"
@@ -602,56 +1005,56 @@
"type": "object",
"properties": {
"auctionTypes": {
+ "description": "The auction types this restriction applies to.",
"type": "array",
"items": {
+ "type": "string",
"enum": [
"OPEN_AUCTION",
"DIRECT_DEALS"
- ],
- "type": "string"
+ ]
},
"enumDescriptions": [
"The restriction applies to open auction.",
"The restriction applies to direct deals."
- ],
- "description": "The auction types this restriction applies to."
+ ]
}
},
"id": "AuctionContext"
},
+ "ListClientUserInvitationsResponse": {
+ "properties": {
+ "invitations": {
+ "description": "The returned list of client users.",
+ "type": "array",
+ "items": {
+ "$ref": "ClientUserInvitation"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "ListClientUserInvitationsResponse",
+ "type": "object"
+ },
"ListClientUsersResponse": {
+ "id": "ListClientUsersResponse",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
- "type": "string"
- },
"users": {
"description": "The returned list of client users.",
"type": "array",
"items": {
"$ref": "ClientUser"
}
- }
- },
- "id": "ListClientUsersResponse"
- },
- "ListClientUserInvitationsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
- "type": "string"
},
- "invitations": {
- "type": "array",
- "items": {
- "$ref": "ClientUserInvitation"
- },
- "description": "The returned list of client users."
+ "nextPageToken": {
+ "type": "string",
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results."
}
- },
- "id": "ListClientUserInvitationsResponse"
+ }
},
"LocationContext": {
"description": "@OutputOnly The Geo criteria the restriction applies to.",
@@ -673,6 +1076,11 @@
"type": "object",
"properties": {
"platforms": {
+ "enumDescriptions": [
+ "Desktop platform.",
+ "Android platform.",
+ "iOS platform."
+ ],
"description": "The platforms this restriction applies to.",
"type": "array",
"items": {
@@ -682,12 +1090,7 @@
"ANDROID",
"IOS"
]
- },
- "enumDescriptions": [
- "Desktop platform.",
- "Android platform.",
- "iOS platform."
- ]
+ }
}
},
"id": "PlatformContext"
@@ -702,12 +1105,6 @@
"type": "string"
},
"status": {
- "enumDescriptions": [
- "A placeholder for an undefined user status.",
- "A user who was already created but hasn't accepted the invitation yet.",
- "A user that is currently active.",
- "A user that is currently disabled."
- ],
"enum": [
"USER_STATUS_UNSPECIFIED",
"PENDING",
@@ -715,7 +1112,13 @@
"DISABLED"
],
"description": "The status of the client user.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined user status.",
+ "A user who was already created but hasn't accepted the invitation yet.",
+ "A user that is currently active.",
+ "A user that is currently disabled."
+ ]
},
"userId": {
"description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
@@ -728,427 +1131,13 @@
}
},
"id": "ClientUser"
- },
- "CreativeDealAssociation": {
- "properties": {
- "accountId": {
- "description": "The account the creative belongs to.",
- "type": "string"
- },
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
- "type": "string"
- },
- "dealsId": {
- "description": "The externalDealId for the deal associated with the creative.",
- "type": "string"
- }
- },
- "id": "CreativeDealAssociation",
- "description": "The association between a creative and a deal.",
- "type": "object"
- },
- "Creative": {
- "description": "A creative and its classification data.",
- "type": "object",
- "properties": {
- "native": {
- "description": "A native creative.",
- "$ref": "NativeContent"
- },
- "video": {
- "$ref": "VideoContent",
- "description": "A video creative."
- },
- "servingRestrictions": {
- "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
- "type": "array",
- "items": {
- "$ref": "ServingRestriction"
- }
- },
- "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": {
- "type": "integer",
- "description": "@OutputOnly The version of this creative.",
- "format": "int32"
- },
- "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": {
- "enumDescriptions": [
- "The status is unknown.",
- "The creative has not been checked.",
- "The creative has been conditionally approved.\nSee serving_restrictions for details.",
- "The creative has been approved.",
- "The creative has been disapproved."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "NOT_CHECKED",
- "CONDITIONALLY_APPROVED",
- "APPROVED",
- "DISAPPROVED"
- ],
- "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string"
- },
- "detectedProductCategories": {
- "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "openAuctionStatus": {
- "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 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."
- },
- "advertiserName": {
- "description": "The name of the company being advertised in the creative.",
- "type": "string"
- },
- "detectedAdvertiserIds": {
- "description": "@OutputOnly Detected advertiser IDs, if any.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
- },
- "detectedDomains": {
- "description": "@OutputOnly\nThe detected domains for this creative.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "filteringStats": {
- "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": {
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "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": {
- "type": "object",
- "properties": {
- "association": {
- "$ref": "CreativeDealAssociation",
- "description": "The association between a creative and a deal that should be removed."
- }
- },
- "id": "RemoveDealAssociationRequest",
- "description": "A request for removing the association between a deal and a creative."
- },
- "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": {
- "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"
- ]
- },
- "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": {
- "enum": [
- "CLIENT_STATUS_UNSPECIFIED",
- "DISABLED",
- "ACTIVE"
- ],
- "description": "The status of the client buyer.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined client status.",
- "A client that is currently disabled.",
- "A client that is currently active."
- ]
- }
- },
- "id": "Client"
- },
- "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"
}
},
- "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": "AdExchangeBuyerII",
"auth": {
"oauth2": {
@@ -1170,16 +1159,47 @@
"resources": {
"clients": {
"methods": {
+ "create": {
+ "path": "v2beta1/accounts/{accountId}/clients",
+ "id": "adexchangebuyer2.accounts.clients.create",
+ "request": {
+ "$ref": "Client"
+ },
+ "description": "Creates a new client buyer.",
+ "response": {
+ "$ref": "Client"
+ },
+ "parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients"
+ },
"get": {
"description": "Gets a client buyer with a given client account ID.",
"httpMethod": "GET",
+ "response": {
+ "$ref": "Client"
+ },
"parameterOrder": [
"accountId",
"clientAccountId"
],
- "response": {
- "$ref": "Client"
- },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"parameters": {
"accountId": {
"description": "Numerical account ID of the client's sponsor buyer. (required)",
@@ -1189,16 +1209,13 @@
"location": "path"
},
"clientAccountId": {
- "location": "path",
"description": "Numerical account ID of the client buyer to retrieve. (required)",
"format": "int64",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"id": "adexchangebuyer2.accounts.clients.get",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}"
@@ -1206,24 +1223,27 @@
"list": {
"description": "Lists all the clients for the current sponsor buyer.",
"httpMethod": "GET",
- "response": {
- "$ref": "ListClientsResponse"
- },
"parameterOrder": [
"accountId"
],
+ "response": {
+ "$ref": "ListClientsResponse"
+ },
+ "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"
+ "type": "string",
+ "location": "query"
},
"accountId": {
- "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
- "format": "int64",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
+ "format": "int64"
},
"pageSize": {
"description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
@@ -1232,99 +1252,152 @@
"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"
},
"update": {
+ "description": "Updates an existing client buyer.",
"request": {
"$ref": "Client"
},
- "description": "Updates an existing client buyer.",
- "response": {
- "$ref": "Client"
- },
+ "httpMethod": "PUT",
"parameterOrder": [
"accountId",
"clientAccountId"
],
- "httpMethod": "PUT",
- "parameters": {
- "accountId": {
- "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clientAccountId": {
- "description": "Unique numerical account ID of the client to update. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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"
- },
- "create": {
- "path": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.create",
- "description": "Creates a new client buyer.",
- "request": {
- "$ref": "Client"
- },
"response": {
"$ref": "Client"
},
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"accountId": {
"location": "path",
- "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
+ "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "location": "path",
+ "description": "Unique numerical account ID of the client to update. (required)",
"format": "int64",
"required": true,
"type": "string"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/clients"
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "id": "adexchangebuyer2.accounts.clients.update",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}"
}
},
"resources": {
"invitations": {
"methods": {
- "create": {
+ "get": {
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "invitationId"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
+ "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"
+ },
"accountId": {
"location": "path",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"required": true,
"type": "string"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
+ "id": "adexchangebuyer2.accounts.clients.invitations.get",
+ "description": "Retrieves an existing client user invitation."
+ },
+ "list": {
+ "description": "Lists all the client users invitations for a client\nwith a given account ID.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListClientUserInvitationsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
+ "type": "string"
},
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"required": true,
"type": "string",
"location": "path"
+ },
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "id": "adexchangebuyer2.accounts.clients.invitations.list",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations"
+ },
+ "create": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
+ "format": "int64"
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
@@ -1342,148 +1415,32 @@
"clientAccountId"
],
"httpMethod": "POST"
- },
- "get": {
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
- "id": "adexchangebuyer2.accounts.clients.invitations.get",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
- "description": "Retrieves an existing client user invitation.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "invitationId"
- ],
- "response": {
- "$ref": "ClientUserInvitation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "invitationId": {
- "description": "Numerical identifier of the user invitation to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "accountId": {
- "location": "path",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- }
- }
- },
+ }
+ }
+ },
+ "users": {
+ "methods": {
"list": {
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "id": "adexchangebuyer2.accounts.clients.users.list",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"clientAccountId"
],
"response": {
- "$ref": "ListClientUserInvitationsResponse"
+ "$ref": "ListClientUsersResponse"
},
"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"
- },
- "pageSize": {
"location": "query",
- "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- },
- "clientAccountId": {
- "location": "path",
- "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.list",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "description": "Lists all the client users invitations for a client\nwith a given account ID."
- }
- }
- },
- "users": {
- "methods": {
- "update": {
- "request": {
- "$ref": "ClientUser"
- },
- "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "userId"
- ],
- "response": {
- "$ref": "ClientUser"
- },
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Numerical identifier of the user to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "accountId": {
- "location": "path",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "clientAccountId": {
- "location": "path",
- "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.update",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}"
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"accountId": {
"location": "path",
@@ -1493,10 +1450,10 @@
"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": {
"location": "path",
@@ -1504,22 +1461,51 @@
"required": true,
"type": "string"
}
- },
- "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"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "GET"
+ }
},
"get": {
+ "description": "Retrieves an existing client user.",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "userId"
+ ],
"httpMethod": "GET",
+ "response": {
+ "$ref": "ClientUser"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "userId": {
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "accountId": {
+ "location": "path",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ },
+ "clientAccountId": {
+ "location": "path",
+ "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "id": "adexchangebuyer2.accounts.clients.users.get"
+ },
+ "update": {
+ "httpMethod": "PUT",
"parameterOrder": [
"accountId",
"clientAccountId",
@@ -1532,32 +1518,35 @@
"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\nthat the user to be retrieved is associated with. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
"userId": {
"description": "Numerical identifier of the user to retrieve. (required)",
"format": "int64",
"required": true,
"type": "string",
"location": "path"
+ },
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.get",
+ "id": "adexchangebuyer2.accounts.clients.users.update",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "description": "Retrieves an existing client user."
+ "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
+ "request": {
+ "$ref": "ClientUser"
+ }
}
}
}
@@ -1565,78 +1554,25 @@
},
"creatives": {
"methods": {
- "watch": {
- "id": "adexchangebuyer2.accounts.creatives.watch",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "update": {
"request": {
- "$ref": "WatchCreativeRequest"
+ "$ref": "Creative"
},
- "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
- "httpMethod": "POST",
+ "description": "Updates a creative.",
+ "httpMethod": "PUT",
"parameterOrder": [
"accountId",
"creativeId"
],
"response": {
- "$ref": "Empty"
- },
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "The account of the creative to watch.",
- "required": true,
- "type": "string"
- },
- "creativeId": {
- "location": "path",
- "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch"
- },
- "get": {
- "response": {
"$ref": "Creative"
},
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
"accountId": {
- "required": true,
- "type": "string",
"location": "path",
- "description": "The account the creative belongs to."
- },
- "creativeId": {
- "description": "The ID of the creative to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "id": "adexchangebuyer2.accounts.creatives.get",
- "description": "Gets a creative."
- },
- "update": {
- "parameters": {
- "accountId": {
"description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"creativeId": {
"location": "path",
@@ -1649,25 +1585,10 @@
"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.",
- "response": {
- "$ref": "Creative"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "PUT"
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}"
},
"list": {
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.list",
- "description": "Lists creatives.",
"response": {
"$ref": "ListCreativesResponse"
},
@@ -1675,9 +1596,6 @@
"accountId"
],
"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\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
@@ -1697,14 +1615,27 @@
"type": "integer"
},
"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"
+ "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'"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/creatives"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.list",
+ "description": "Lists creatives."
},
"create": {
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.create",
+ "description": "Creates a creative.",
+ "request": {
+ "$ref": "Creative"
+ },
"response": {
"$ref": "Creative"
},
@@ -1716,83 +1647,153 @@
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
- "duplicateIdMode": {
- "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
- "type": "string",
- "location": "query",
- "enum": [
- "NO_DUPLICATES",
- "FORCE_ENABLE_DUPLICATE_IDS"
- ]
- },
"accountId": {
"description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "duplicateIdMode": {
+ "location": "query",
+ "enum": [
+ "NO_DUPLICATES",
+ "FORCE_ENABLE_DUPLICATE_IDS"
+ ],
+ "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
+ "type": "string"
}
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.create",
- "description": "Creates a creative.",
- "request": {
- "$ref": "Creative"
}
},
"stopWatching": {
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "id": "adexchangebuyer2.accounts.creatives.stopWatching",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
- "request": {
- "$ref": "StopWatchingCreativeRequest"
+ "response": {
+ "$ref": "Empty"
},
- "httpMethod": "POST",
"parameterOrder": [
"accountId",
"creativeId"
],
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"accountId": {
+ "location": "path",
"description": "The account of the creative to stop notifications for.",
"required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
+ "required": true,
"type": "string",
"location": "path"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "id": "adexchangebuyer2.accounts.creatives.stopWatching",
+ "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
+ "request": {
+ "$ref": "StopWatchingCreativeRequest"
+ }
+ },
+ "watch": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "The account of the creative to watch.",
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "id": "adexchangebuyer2.accounts.creatives.watch",
+ "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
+ "request": {
+ "$ref": "WatchCreativeRequest"
+ }
+ },
+ "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"
},
"creativeId": {
"location": "path",
- "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
+ "description": "The ID of the creative to retrieve.",
"required": true,
"type": "string"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "id": "adexchangebuyer2.accounts.creatives.get"
}
},
"resources": {
"dealAssociations": {
"methods": {
"list": {
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
+ "description": "List all creative-deal associations.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDealAssociationsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
],
"parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
+ "creativeId": {
+ "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
+ "required": true,
"type": "string",
- "location": "query"
+ "location": "path"
+ },
+ "pageToken": {
+ "type": "string",
+ "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."
},
"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"
+ "type": "string",
+ "location": "path",
+ "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to."
},
"pageSize": {
"description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
@@ -1801,33 +1802,19 @@
"location": "query"
},
"query": {
+ "location": "query",
"description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
- "type": "string",
- "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"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
- "description": "List all creative-deal associations.",
- "response": {
- "$ref": "ListDealAssociationsResponse"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
],
- "httpMethod": "GET"
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations"
},
"add": {
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
"request": {
"$ref": "AddDealAssociationRequest"
},
@@ -1841,14 +1828,14 @@
"$ref": "Empty"
},
"parameters": {
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
+ "accountId": {
+ "description": "The account the creative belongs to.",
"required": true,
"type": "string",
"location": "path"
},
- "accountId": {
- "description": "The account the creative belongs to.",
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
"required": true,
"type": "string",
"location": "path"
@@ -1857,7 +1844,9 @@
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add"
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add"
},
"remove": {
"response": {
@@ -1873,16 +1862,16 @@
],
"parameters": {
"accountId": {
- "location": "path",
"description": "The account the creative belongs to.",
"required": true,
- "type": "string"
- },
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
- "required": true,
"type": "string",
"location": "path"
+ },
+ "creativeId": {
+ "location": "path",
+ "description": "The ID of the creative associated with the deal.",
+ "required": true,
+ "type": "string"
}
},
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
@@ -1901,36 +1890,26 @@
}
},
"parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
+ "quotaUser": {
"location": "query",
- "description": "OAuth access token.",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
"pp": {
- "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"
+ "location": "query",
+ "description": "Pretty-print response."
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -1938,10 +1917,10 @@
"location": "query"
},
"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."
},
"uploadType": {
"location": "query",
@@ -1949,43 +1928,64 @@
"type": "string"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
"type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format."
+ "location": "query"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
- "alt": {
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
+ "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"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "version": "v2beta1",
+ "baseUrl": "https://adexchangebuyer.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20170531",
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/guides/client-access/",
+ "id": "adexchangebuyer2:v2beta1",
+ "discoveryVersion": "v1",
+ "version_module": "True"
}
diff --git a/adexperiencereport/v1/adexperiencereport-api.json b/adexperiencereport/v1/adexperiencereport-api.json
new file mode 100644
index 0000000..6303ca0
--- /dev/null
+++ b/adexperiencereport/v1/adexperiencereport-api.json
@@ -0,0 +1,297 @@
+{
+ "name": "adexperiencereport",
+ "batchPath": "batch",
+ "title": "Google Ad Experience Report API",
+ "ownerName": "Google",
+ "resources": {
+ "violatingSites": {
+ "methods": {
+ "list": {
+ "path": "v1/violatingSites",
+ "id": "adexperiencereport.violatingSites.list",
+ "description": "Lists sites with Ad Experience Report statuses of \"Reviewed - out of\ncompliance,\" \"Reviewed - significantly out of compliance,\" or \"Failed\nreview - egregious issues found.\"",
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ViolatingSitesResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ],
+ "flatPath": "v1/violatingSites"
+ }
+ }
+ },
+ "sites": {
+ "methods": {
+ "get": {
+ "description": "Gets a summary of the ads rating of a site.",
+ "response": {
+ "$ref": "SiteSummaryResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The required site name. It should be a site property registered in Search\nConsole. The server will return an error of BAD_REQUEST if this field is\nnot filled in.",
+ "required": true,
+ "type": "string",
+ "pattern": "^sites/[^/]+$"
+ }
+ },
+ "flatPath": "v1/sites/{sitesId}",
+ "path": "v1/{+name}",
+ "id": "adexperiencereport.sites.get"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://adexperiencereport.googleapis.com/",
+ "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "basePath": "",
+ "documentationLink": "https://developers.google.com/apis-explorer/#search/adexperiencereport/adexperiencereport/v1/",
+ "revision": "20170525",
+ "id": "adexperiencereport:v1",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "schemas": {
+ "PlatformSummary": {
+ "description": "Summary of the ads rating of a site for a specific platform.",
+ "type": "object",
+ "properties": {
+ "reportUrl": {
+ "description": "A link that leads to a full ad experience report.",
+ "type": "string"
+ },
+ "lastChangeTime": {
+ "description": "The last time that the site changed status.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "egregiousStatus": {
+ "description": "The status of the site reviewed for egregious ads.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not reviewed.",
+ "Passing.",
+ "Failing."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PASSING",
+ "FAILING"
+ ]
+ },
+ "betterAdsStatus": {
+ "description": "The status of the site reviewed for the Better Ads Standards.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not reviewed.",
+ "Passing.",
+ "Warning.",
+ "Failing."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PASSING",
+ "WARNING",
+ "FAILING"
+ ]
+ },
+ "enforcementTime": {
+ "type": "string",
+ "description": "The date on which ad filtering begins.",
+ "format": "google-datetime"
+ },
+ "region": {
+ "enumDescriptions": [
+ "Ad standard not yet defined for your region.",
+ "Region A.",
+ "Region B."
+ ],
+ "description": "The assigned regions for the site and platform.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "REGION_UNKNOWN",
+ "REGION_A",
+ "REGION_B"
+ ],
+ "type": "string"
+ }
+ },
+ "filterStatus": {
+ "type": "string",
+ "enumDescriptions": [
+ "N/A.",
+ "Ad filtering is on.",
+ "Ad filtering is off.",
+ "Ad filtering is paused.",
+ "Ad filtering is pending."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ON",
+ "OFF",
+ "PAUSED",
+ "PENDING"
+ ],
+ "description": "The ad filtering status of the site."
+ },
+ "underReview": {
+ "description": "Whether the site is currently under review.",
+ "type": "boolean"
+ }
+ },
+ "id": "PlatformSummary"
+ },
+ "ViolatingSitesResponse": {
+ "description": "Response message for ListViolatingSites.",
+ "type": "object",
+ "properties": {
+ "violatingSites": {
+ "description": "A list of summaries of violating sites.",
+ "type": "array",
+ "items": {
+ "$ref": "SiteSummaryResponse"
+ }
+ }
+ },
+ "id": "ViolatingSitesResponse"
+ },
+ "SiteSummaryResponse": {
+ "description": "Response message for GetSiteSummary.",
+ "type": "object",
+ "properties": {
+ "mobileSummary": {
+ "$ref": "PlatformSummary",
+ "description": "Summary for the mobile review of the site."
+ },
+ "reviewedSite": {
+ "type": "string",
+ "description": "The name of the site reviewed."
+ },
+ "desktopSummary": {
+ "description": "Summary for the desktop review of the site.",
+ "$ref": "PlatformSummary"
+ }
+ },
+ "id": "SiteSummaryResponse"
+ }
+ },
+ "protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "canonicalName": "Ad Experience Report",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/xapi.zoo": {
+ "description": "Test scope for access to the Zoo service"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://adexperiencereport.googleapis.com/",
+ "ownerDomain": "google.com"
+}
diff --git a/adexperiencereport/v1/adexperiencereport-gen.go b/adexperiencereport/v1/adexperiencereport-gen.go
new file mode 100644
index 0000000..daee87b
--- /dev/null
+++ b/adexperiencereport/v1/adexperiencereport-gen.go
@@ -0,0 +1,511 @@
+// Package adexperiencereport provides access to the Google Ad Experience Report API.
+//
+// See https://developers.google.com/apis-explorer/#search/adexperiencereport/adexperiencereport/v1/
+//
+// Usage example:
+//
+// import "google.golang.org/api/adexperiencereport/v1"
+// ...
+// adexperiencereportService, err := adexperiencereport.New(oauthHttpClient)
+package adexperiencereport // import "google.golang.org/api/adexperiencereport/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 = "adexperiencereport:v1"
+const apiName = "adexperiencereport"
+const apiVersion = "v1"
+const basePath = "https://adexperiencereport.googleapis.com/"
+
+// OAuth2 scopes used by this API.
+const (
+ // Test scope for access to the Zoo service
+ XapiZooScope = "https://www.googleapis.com/auth/xapi.zoo"
+)
+
+func New(client *http.Client) (*Service, error) {
+ if client == nil {
+ return nil, errors.New("client is nil")
+ }
+ s := &Service{client: client, BasePath: basePath}
+ s.Sites = NewSitesService(s)
+ s.ViolatingSites = NewViolatingSitesService(s)
+ return s, nil
+}
+
+type Service struct {
+ client *http.Client
+ BasePath string // API endpoint base URL
+ UserAgent string // optional additional User-Agent fragment
+
+ Sites *SitesService
+
+ ViolatingSites *ViolatingSitesService
+}
+
+func (s *Service) userAgent() string {
+ if s.UserAgent == "" {
+ return googleapi.UserAgent
+ }
+ return googleapi.UserAgent + " " + s.UserAgent
+}
+
+func NewSitesService(s *Service) *SitesService {
+ rs := &SitesService{s: s}
+ return rs
+}
+
+type SitesService struct {
+ s *Service
+}
+
+func NewViolatingSitesService(s *Service) *ViolatingSitesService {
+ rs := &ViolatingSitesService{s: s}
+ return rs
+}
+
+type ViolatingSitesService struct {
+ s *Service
+}
+
+// PlatformSummary: Summary of the ads rating of a site for a specific
+// platform.
+type PlatformSummary struct {
+ // BetterAdsStatus: The status of the site reviewed for the Better Ads
+ // Standards.
+ //
+ // Possible values:
+ // "UNKNOWN" - Not reviewed.
+ // "PASSING" - Passing.
+ // "WARNING" - Warning.
+ // "FAILING" - Failing.
+ BetterAdsStatus string `json:"betterAdsStatus,omitempty"`
+
+ // EgregiousStatus: The status of the site reviewed for egregious ads.
+ //
+ // Possible values:
+ // "UNKNOWN" - Not reviewed.
+ // "PASSING" - Passing.
+ // "FAILING" - Failing.
+ EgregiousStatus string `json:"egregiousStatus,omitempty"`
+
+ // EnforcementTime: The date on which ad filtering begins.
+ EnforcementTime string `json:"enforcementTime,omitempty"`
+
+ // FilterStatus: The ad filtering status of the site.
+ //
+ // Possible values:
+ // "UNKNOWN" - N/A.
+ // "ON" - Ad filtering is on.
+ // "OFF" - Ad filtering is off.
+ // "PAUSED" - Ad filtering is paused.
+ // "PENDING" - Ad filtering is pending.
+ FilterStatus string `json:"filterStatus,omitempty"`
+
+ // LastChangeTime: The last time that the site changed status.
+ LastChangeTime string `json:"lastChangeTime,omitempty"`
+
+ // Region: The assigned regions for the site and platform.
+ //
+ // Possible values:
+ // "REGION_UNKNOWN" - Ad standard not yet defined for your region.
+ // "REGION_A" - Region A.
+ // "REGION_B" - Region B.
+ Region []string `json:"region,omitempty"`
+
+ // ReportUrl: A link that leads to a full ad experience report.
+ ReportUrl string `json:"reportUrl,omitempty"`
+
+ // UnderReview: Whether the site is currently under review.
+ UnderReview bool `json:"underReview,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "BetterAdsStatus") 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. "BetterAdsStatus") 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 *PlatformSummary) MarshalJSON() ([]byte, error) {
+ type noMethod PlatformSummary
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SiteSummaryResponse: Response message for GetSiteSummary.
+type SiteSummaryResponse struct {
+ // DesktopSummary: Summary for the desktop review of the site.
+ DesktopSummary *PlatformSummary `json:"desktopSummary,omitempty"`
+
+ // MobileSummary: Summary for the mobile review of the site.
+ MobileSummary *PlatformSummary `json:"mobileSummary,omitempty"`
+
+ // ReviewedSite: The name of the site reviewed.
+ ReviewedSite string `json:"reviewedSite,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "DesktopSummary") 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. "DesktopSummary") 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 *SiteSummaryResponse) MarshalJSON() ([]byte, error) {
+ type noMethod SiteSummaryResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ViolatingSitesResponse: Response message for ListViolatingSites.
+type ViolatingSitesResponse struct {
+ // ViolatingSites: A list of summaries of violating sites.
+ ViolatingSites []*SiteSummaryResponse `json:"violatingSites,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "ViolatingSites") 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. "ViolatingSites") 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 *ViolatingSitesResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ViolatingSitesResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// method id "adexperiencereport.sites.get":
+
+type SitesGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Gets a summary of the ads rating of a site.
+func (r *SitesService) Get(name string) *SitesGetCall {
+ c := &SitesGetCall{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 *SitesGetCall) Fields(s ...googleapi.Field) *SitesGetCall {
+ 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 *SitesGetCall) IfNoneMatch(entityTag string) *SitesGetCall {
+ 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 *SitesGetCall) Context(ctx context.Context) *SitesGetCall {
+ 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 *SitesGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *SitesGetCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "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 "adexperiencereport.sites.get" call.
+// Exactly one of *SiteSummaryResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *SiteSummaryResponse.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 *SitesGetCall) Do(opts ...googleapi.CallOption) (*SiteSummaryResponse, 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 := &SiteSummaryResponse{
+ 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 summary of the ads rating of a site.",
+ // "flatPath": "v1/sites/{sitesId}",
+ // "httpMethod": "GET",
+ // "id": "adexperiencereport.sites.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The required site name. It should be a site property registered in Search\nConsole. The server will return an error of BAD_REQUEST if this field is\nnot filled in.",
+ // "location": "path",
+ // "pattern": "^sites/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "SiteSummaryResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/xapi.zoo"
+ // ]
+ // }
+
+}
+
+// method id "adexperiencereport.violatingSites.list":
+
+type ViolatingSitesListCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists sites with Ad Experience Report statuses of "Reviewed -
+// out of
+// compliance," "Reviewed - significantly out of compliance," or
+// "Failed
+// review - egregious issues found."
+func (r *ViolatingSitesService) List() *ViolatingSitesListCall {
+ c := &ViolatingSitesListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ 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 *ViolatingSitesListCall) Fields(s ...googleapi.Field) *ViolatingSitesListCall {
+ 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 *ViolatingSitesListCall) IfNoneMatch(entityTag string) *ViolatingSitesListCall {
+ 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 *ViolatingSitesListCall) Context(ctx context.Context) *ViolatingSitesListCall {
+ 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 *ViolatingSitesListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ViolatingSitesListCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/violatingSites")
+ 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 "adexperiencereport.violatingSites.list" call.
+// Exactly one of *ViolatingSitesResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ViolatingSitesResponse.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 *ViolatingSitesListCall) Do(opts ...googleapi.CallOption) (*ViolatingSitesResponse, 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 := &ViolatingSitesResponse{
+ 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 sites with Ad Experience Report statuses of \"Reviewed - out of\ncompliance,\" \"Reviewed - significantly out of compliance,\" or \"Failed\nreview - egregious issues found.\"",
+ // "flatPath": "v1/violatingSites",
+ // "httpMethod": "GET",
+ // "id": "adexperiencereport.violatingSites.list",
+ // "parameterOrder": [],
+ // "parameters": {},
+ // "path": "v1/violatingSites",
+ // "response": {
+ // "$ref": "ViolatingSitesResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/xapi.zoo"
+ // ]
+ // }
+
+}
diff --git a/analyticsreporting/v4/analyticsreporting-api.json b/analyticsreporting/v4/analyticsreporting-api.json
index a2ee1b1..36686bc 100644
--- a/analyticsreporting/v4/analyticsreporting-api.json
+++ b/analyticsreporting/v4/analyticsreporting-api.json
@@ -1,11 +1,363 @@
{
"basePath": "",
- "id": "analyticsreporting:v4",
+ "revision": "20170531",
"documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
- "revision": "20170427",
+ "id": "analyticsreporting:v4",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "ReportData": {
+ "properties": {
+ "minimums": {
+ "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
+ "type": "array",
+ "items": {
+ "$ref": "DateRangeValues"
+ }
+ },
+ "samplingSpaceSizes": {
+ "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of\nsamples present, one entry per date range. If the results are not sampled\nthis field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
+ "type": "array",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "totals": {
+ "description": "For each requested date range, for the set of all rows that match\nthe query, every requested value format gets a total. The total\nfor a value format is computed by first totaling the metrics\nmentioned in the value format and then evaluating the value\nformat as a scalar expression. E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of all relevant ga:sessions) + 2)`.\nTotals are computed before pagination.",
+ "type": "array",
+ "items": {
+ "$ref": "DateRangeValues"
+ }
+ },
+ "samplesReadCounts": {
+ "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of samples read, one entry per date range.\nIf the results are not sampled this field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
+ "type": "array",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "isDataGolden": {
+ "description": "Indicates if response to this request is golden or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
+ "type": "boolean"
+ },
+ "rows": {
+ "description": "There's one ReportRow for every unique combination of dimensions.",
+ "type": "array",
+ "items": {
+ "$ref": "ReportRow"
+ }
+ },
+ "rowCount": {
+ "description": "Total number of matching rows for this query.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dataLastRefreshed": {
+ "type": "string",
+ "description": "The last time the data in the report was refreshed. All the hits received\nbefore this timestamp are included in the calculation of the report.",
+ "format": "google-datetime"
+ },
+ "maximums": {
+ "type": "array",
+ "items": {
+ "$ref": "DateRangeValues"
+ },
+ "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero."
+ }
+ },
+ "id": "ReportData",
+ "description": "The data part of the report.",
+ "type": "object"
+ },
+ "DimensionFilter": {
+ "description": "Dimension filter specifies the filtering options on a dimension.",
+ "type": "object",
+ "properties": {
+ "caseSensitive": {
+ "description": "Should the match be case sensitive? Default is false.",
+ "type": "boolean"
+ },
+ "dimensionName": {
+ "description": "The dimension to filter on. A DimensionFilter must contain a dimension.",
+ "type": "string"
+ },
+ "operator": {
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "REGEXP",
+ "BEGINS_WITH",
+ "ENDS_WITH",
+ "PARTIAL",
+ "EXACT",
+ "NUMERIC_EQUAL",
+ "NUMERIC_GREATER_THAN",
+ "NUMERIC_LESS_THAN",
+ "IN_LIST"
+ ],
+ "description": "How to match the dimension to the expression. The default is REGEXP.",
+ "type": "string",
+ "enumDescriptions": [
+ "If the match type is unspecified, it is treated as a `REGEXP`.",
+ "The match expression is treated as a regular expression. All match types\nare not treated as regular expressions.",
+ "Matches the value 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.",
+ "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.",
+ "Checks if the dimension is numerically greater than the match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions.",
+ "Checks if the dimension is numerically less than the match expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.",
+ "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter."
+ ]
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "description": "A dynamic segment definition in the request.",
+ "$ref": "DynamicSegment"
+ },
+ "segmentId": {
+ "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
+ "type": "string"
+ }
+ },
+ "id": "Segment"
+ },
+ "OrderBy": {
+ "properties": {
+ "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": {
+ "enumDescriptions": [
+ "Unspecified order type will be treated as sort based on value.",
+ "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
+ "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
+ "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
+ "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
+ "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
+ ],
+ "enum": [
+ "ORDER_TYPE_UNSPECIFIED",
+ "VALUE",
+ "DELTA",
+ "SMART",
+ "HISTOGRAM_BUCKET",
+ "DIMENSION_AS_INTEGER"
+ ],
+ "description": "The order type. The default orderType is `VALUE`.",
+ "type": "string"
+ }
+ },
+ "id": "OrderBy",
+ "description": "Specifies the sorting options.",
+ "type": "object"
+ },
+ "SegmentDimensionFilter": {
+ "description": "Dimension filter specifies the filtering options on a dimension.",
+ "type": "object",
+ "properties": {
+ "maxComparisonValue": {
+ "description": "Maximum comparison values for `BETWEEN` match type.",
+ "type": "string"
+ },
+ "dimensionName": {
+ "description": "Name of the dimension for which the filter is being applied.",
+ "type": "string"
+ },
+ "operator": {
+ "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."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "REGEXP",
+ "BEGINS_WITH",
+ "ENDS_WITH",
+ "PARTIAL",
+ "EXACT",
+ "IN_LIST",
+ "NUMERIC_LESS_THAN",
+ "NUMERIC_GREATER_THAN",
+ "NUMERIC_BETWEEN"
+ ]
+ },
+ "expressions": {
+ "description": "The list of expressions, only the first element is used for all operators",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "caseSensitive": {
+ "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
+ "type": "boolean"
+ },
+ "minComparisonValue": {
+ "description": "Minimum comparison values for `BETWEEN` match type.",
+ "type": "string"
+ }
+ },
+ "id": "SegmentDimensionFilter"
+ },
+ "SegmentSequenceStep": {
+ "description": "A segment sequence definition.",
+ "type": "object",
+ "properties": {
+ "orFiltersForSegment": {
+ "description": "A sequence is specified with a list of Or grouped filters which are\ncombined with `AND` operator.",
+ "type": "array",
+ "items": {
+ "$ref": "OrFiltersForSegment"
+ }
+ },
+ "matchType": {
+ "description": "Specifies if the step immediately precedes or can be any time before the\nnext step.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified match type is treated as precedes.",
+ "Operator indicates that the previous step precedes the next step.",
+ "Operator indicates that the previous step immediately precedes the next\nstep."
+ ],
+ "enum": [
+ "UNSPECIFIED_MATCH_TYPE",
+ "PRECEDES",
+ "IMMEDIATELY_PRECEDES"
+ ]
+ }
+ },
+ "id": "SegmentSequenceStep"
+ },
+ "Metric": {
+ "type": "object",
+ "properties": {
+ "formattingType": {
+ "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."
+ ],
+ "enum": [
+ "METRIC_TYPE_UNSPECIFIED",
+ "INTEGER",
+ "FLOAT",
+ "CURRENCY",
+ "PERCENT",
+ "TIME"
+ ]
+ },
+ "alias": {
+ "description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
+ "type": "string"
+ }
+ },
+ "id": "Metric",
+ "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": {
+ "properties": {
+ "values": {
+ "description": "The values of the metrics in each of the pivot regions.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "PivotValueRegion",
+ "description": "The metric values in the pivot region.",
+ "type": "object"
+ },
+ "Report": {
+ "id": "Report",
+ "description": "The data response corresponding to the request.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "Response data.",
+ "$ref": "ReportData"
+ },
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.",
+ "type": "string"
+ },
+ "columnHeader": {
+ "description": "The column headers.",
+ "$ref": "ColumnHeader"
+ }
+ }
+ },
+ "PivotHeader": {
+ "id": "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"
+ }
+ },
+ "totalPivotGroupsCount": {
+ "description": "The total number of groups for this pivot.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
"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",
@@ -25,22 +377,7 @@
"description": "MetricFilter specifies the filter on a metric.",
"type": "object",
"properties": {
- "metricName": {
- "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
- "type": "string"
- },
- "comparisonValue": {
- "type": "string",
- "description": "The value to compare against."
- },
"operator": {
- "enumDescriptions": [
- "If the operator is not specified, it is treated as `EQUAL`.",
- "Should the value of the metric be exactly equal to the comparison value.",
- "Should the value of the metric be less than to the comparison value.",
- "Should the value of the metric be greater than to the comparison value.",
- "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
- ],
"enum": [
"OPERATOR_UNSPECIFIED",
"EQUAL",
@@ -49,11 +386,26 @@
"IS_MISSING"
],
"description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "If the operator is not specified, it is treated as `EQUAL`.",
+ "Should the value of the metric be exactly equal to the comparison value.",
+ "Should the value of the metric be less than to the comparison value.",
+ "Should the value of the metric be greater than to the comparison value.",
+ "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
+ ]
},
"not": {
"description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
"type": "boolean"
+ },
+ "metricName": {
+ "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
+ "type": "string"
+ },
+ "comparisonValue": {
+ "description": "The value to compare against.",
+ "type": "string"
}
},
"id": "MetricFilter"
@@ -62,35 +414,6 @@
"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"
- }
- },
- "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": {
- "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
- "type": "string"
- },
- "pivots": {
- "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
- "type": "array",
- "items": {
- "$ref": "Pivot"
- }
- },
- "includeEmptyRows": {
- "type": "boolean",
- "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."
- },
"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",
@@ -103,22 +426,22 @@
"format": "int32",
"type": "integer"
},
- "hideTotals": {
- "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
- "type": "boolean"
- },
"hideValueRanges": {
"description": "If set to true, hides the minimum and maximum across all matching rows.\nThe default is false and the value ranges are returned.",
"type": "boolean"
},
+ "hideTotals": {
+ "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
+ "type": "boolean"
+ },
+ "filtersExpression": {
+ "type": "string",
+ "description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters)."
+ },
"cohortGroup": {
"$ref": "CohortGroup",
"description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition."
},
- "filtersExpression": {
- "description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
- "type": "string"
- },
"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`.",
"type": "string"
@@ -152,6 +475,12 @@
}
},
"samplingLevel": {
+ "enum": [
+ "SAMPLING_UNSPECIFIED",
+ "DEFAULT",
+ "SMALL",
+ "LARGE"
+ ],
"description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.",
"type": "string",
"enumDescriptions": [
@@ -159,13 +488,36 @@
"Returns response with a sample size that balances speed and\naccuracy.",
"It returns a fast response with a smaller sampling size.",
"Returns a more accurate response using a large sampling size. But this\nmay result in response being slower."
- ],
- "enum": [
- "SAMPLING_UNSPECIFIED",
- "DEFAULT",
- "SMALL",
- "LARGE"
]
+ },
+ "dimensions": {
+ "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
+ "type": "array",
+ "items": {
+ "$ref": "Dimension"
+ }
+ },
+ "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": {
+ "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
+ "type": "string"
+ },
+ "pivots": {
+ "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"
}
},
"id": "ReportRequest"
@@ -178,13 +530,13 @@
"description": "If non-empty, we place dimension values into buckets after string to\nint64. Dimension values that are not the string representation of an\nintegral value will be converted to zero. The bucket values have to be in\nincreasing order. Each bucket is closed on the lower end, and open on the\nupper end. The \"first\" bucket includes all values less than the first\nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nvalues that fall in a bucket get transformed to a new dimension value. For\nexample, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing buckets:\n\n- bucket #1: values \u003c 0, dimension value \"\u003c0\"\n- bucket #2: values in [0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2\"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in [4,7), dimension value \"4-6\"\n- bucket #6: values \u003e= 7, dimension value \"7+\"\n\nNOTE: If you are applying histogram mutation on any dimension, and using\nthat dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for that purpose. Without that the dimension values\nwill be sorted according to dictionary\n(lexicographic) order. For example the ascending dictionary order is:\n\n \"\u003c50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGRAM_BUCKET` order is:\n\n \"\u003c50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe client has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a histogram-mutated dimension.",
"type": "array",
"items": {
- "format": "int64",
- "type": "string"
+ "type": "string",
+ "format": "int64"
}
},
"name": {
- "description": "Name of the dimension to fetch, for example `ga:browser`.",
- "type": "string"
+ "type": "string",
+ "description": "Name of the dimension to fetch, for example `ga:browser`."
}
},
"id": "Dimension"
@@ -208,8 +560,8 @@
"type": "object",
"properties": {
"userSegment": {
- "$ref": "SegmentDefinition",
- "description": "User Segment to select users to include in the segment."
+ "description": "User Segment to select users to include in the segment.",
+ "$ref": "SegmentDefinition"
},
"sessionSegment": {
"$ref": "SegmentDefinition",
@@ -223,41 +575,69 @@
"id": "DynamicSegment"
},
"ColumnHeader": {
- "id": "ColumnHeader",
"description": "Column headers.",
"type": "object",
"properties": {
+ "metricHeader": {
+ "$ref": "MetricHeader",
+ "description": "Metric headers for the metrics in the response."
+ },
"dimensions": {
"description": "The dimension names in the response.",
"type": "array",
"items": {
"type": "string"
}
- },
- "metricHeader": {
- "description": "Metric headers for the metrics in the response.",
- "$ref": "MetricHeader"
}
- }
+ },
+ "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": {
- "$ref": "SegmentMetricFilter",
- "description": "Metric Filter for the segment definition."
+ "description": "Metric Filter for the segment definition.",
+ "$ref": "SegmentMetricFilter"
},
"not": {
- "description": "Matches the complement (`!`) of the filter.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Matches the complement (`!`) of the filter."
},
"dimensionFilter": {
"description": "Dimension Filter for the segment definition.",
"$ref": "SegmentDimensionFilter"
}
},
- "id": "SegmentFilterClause",
- "description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
- "type": "object"
+ "id": "SegmentFilterClause"
+ },
+ "MetricFilterClause": {
+ "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
+ "type": "object",
+ "properties": {
+ "operator": {
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "OR",
+ "AND"
+ ],
+ "description": "The operator for combining multiple metric filters. If unspecified, it is\ntreated as an `OR`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified operator. It is treated as an `OR`.",
+ "The logical `OR` operator.",
+ "The logical `AND` operator."
+ ]
+ },
+ "filters": {
+ "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricFilter"
+ }
+ }
+ },
+ "id": "MetricFilterClause"
},
"ReportRow": {
"description": "A row in the report.",
@@ -271,16 +651,19 @@
}
},
"dimensions": {
- "description": "List of requested dimensions.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "List of requested dimensions."
}
},
"id": "ReportRow"
},
"Cohort": {
+ "id": "Cohort",
+ "description": "Defines a cohort. A cohort is a group of users who share a common\ncharacteristic. For example, all users with the same acquisition date\nbelong to the same cohort.",
+ "type": "object",
"properties": {
"name": {
"description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
@@ -302,52 +685,21 @@
"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"
}
- },
- "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"
- },
- "MetricFilterClause": {
- "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
- "type": "object",
- "properties": {
- "operator": {
- "description": "The operator for combining multiple metric filters. If unspecified, it is\ntreated as an `OR`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified operator. It is treated as an `OR`.",
- "The logical `OR` operator.",
- "The logical `AND` operator."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "OR",
- "AND"
- ]
- },
- "filters": {
- "type": "array",
- "items": {
- "$ref": "MetricFilter"
- },
- "description": "The repeated set of filters. They are logically combined based on the\noperator specified."
- }
- },
- "id": "MetricFilterClause"
+ }
},
"OrFiltersForSegment": {
- "description": "A list of segment filters in the `OR` group are combined with the logical OR\noperator.",
- "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"
+ "id": "OrFiltersForSegment",
+ "description": "A list of segment filters in the `OR` group are combined with the logical OR\noperator.",
+ "type": "object"
},
"MetricHeader": {
"description": "The headers for the metrics.",
@@ -361,11 +713,11 @@
}
},
"pivotHeaders": {
+ "description": "Headers for the pivots in the response.",
"type": "array",
"items": {
"$ref": "PivotHeader"
- },
- "description": "Headers for the pivots in the response."
+ }
}
},
"id": "MetricHeader"
@@ -375,17 +727,17 @@
"type": "object",
"properties": {
"operator": {
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "OR",
- "AND"
- ],
"description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
"type": "string",
"enumDescriptions": [
"Unspecified operator. It is treated as an `OR`.",
"The logical `OR` operator.",
"The logical `AND` operator."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "OR",
+ "AND"
]
},
"filters": {
@@ -434,6 +786,10 @@
"description": "Metric filter to be used in a segment filter clause.",
"type": "object",
"properties": {
+ "metricName": {
+ "description": "The metric that will be filtered on. A `metricFilter` must contain a\nmetric name.",
+ "type": "string"
+ },
"scope": {
"enumDescriptions": [
"If the scope is unspecified, it defaults to the condition scope,\n`USER` or `SESSION` depending on if the segment is trying to choose\nusers or sessions.",
@@ -477,34 +833,30 @@
],
"description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`.",
"type": "string"
- },
- "metricName": {
- "description": "The metric that will be filtered on. A `metricFilter` must contain a\nmetric name.",
- "type": "string"
}
},
"id": "SegmentMetricFilter"
},
"DateRangeValues": {
+ "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
"type": "object",
"properties": {
- "values": {
- "description": "Each value corresponds to each Metric in the request.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"pivotValueRegions": {
"description": "The values of each pivot region.",
"type": "array",
"items": {
"$ref": "PivotValueRegion"
}
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Each value corresponds to each Metric in the request."
}
},
- "id": "DateRangeValues",
- "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination"
+ "id": "DateRangeValues"
},
"CohortGroup": {
"properties": {
@@ -516,8 +868,8 @@
}
},
"lifetimeValue": {
- "type": "boolean",
- "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)"
+ "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",
@@ -525,8 +877,6 @@
"type": "object"
},
"GetReportsRequest": {
- "description": "The batch request containing multiple report request.",
- "type": "object",
"properties": {
"reportRequests": {
"description": "Requests, each request will have a separate response.\nThere can be a maximum of 5 requests. All requests should have the same\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.",
@@ -536,17 +886,14 @@
}
}
},
- "id": "GetReportsRequest"
+ "id": "GetReportsRequest",
+ "description": "The batch request containing multiple report request.",
+ "type": "object"
},
"Pivot": {
"description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
"type": "object",
"properties": {
- "maxGroupCount": {
- "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
- "format": "int32",
- "type": "integer"
- },
"startGroup": {
"description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
"format": "int32",
@@ -572,11 +919,18 @@
"items": {
"$ref": "DimensionFilterClause"
}
+ },
+ "maxGroupCount": {
+ "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
+ "format": "int32",
+ "type": "integer"
}
},
"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": {
"dimensionNames": {
"description": "The name of the dimensions in the pivot response.",
@@ -597,11 +951,11 @@
}
}
},
- "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"
+ "id": "PivotHeaderEntry"
},
"SegmentFilter": {
+ "id": "SegmentFilter",
+ "description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.",
"type": "object",
"properties": {
"sequenceSegment": {
@@ -609,16 +963,14 @@
"description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators."
},
"not": {
- "type": "boolean",
- "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 },"
+ "description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
+ "type": "boolean"
},
"simpleSegment": {
"$ref": "SimpleSegment",
"description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
}
- },
- "id": "SegmentFilter",
- "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."
+ }
},
"SegmentDefinition": {
"description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
@@ -635,12 +987,22 @@
"id": "SegmentDefinition"
},
"MetricHeaderEntry": {
+ "description": "Header for the metrics.",
+ "type": "object",
"properties": {
"name": {
"description": "The name of the header.",
"type": "string"
},
"type": {
+ "enumDescriptions": [
+ "Metric type is unspecified.",
+ "Integer metric.",
+ "Float metric.",
+ "Currency metric.",
+ "Percentage metric.",
+ "Time metric in `HH:MM:SS` format."
+ ],
"enum": [
"METRIC_TYPE_UNSPECIFIED",
"INTEGER",
@@ -650,379 +1012,17 @@
"TIME"
],
"description": "The type of the metric, for example `INTEGER`.",
- "type": "string",
- "enumDescriptions": [
- "Metric type is unspecified.",
- "Integer metric.",
- "Float metric.",
- "Currency metric.",
- "Percentage metric.",
- "Time metric in `HH:MM:SS` format."
- ]
- }
- },
- "id": "MetricHeaderEntry",
- "description": "Header for the metrics.",
- "type": "object"
- },
- "ReportData": {
- "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.",
- "type": "boolean"
- },
- "rows": {
- "description": "There's one ReportRow for every unique combination of dimensions.",
- "type": "array",
- "items": {
- "$ref": "ReportRow"
- }
- },
- "rowCount": {
- "description": "Total number of matching rows for this query.",
- "format": "int32",
- "type": "integer"
- },
- "dataLastRefreshed": {
- "description": "The last time the data in the report was refreshed. All the hits received\nbefore this timestamp are included in the calculation of the report.",
- "format": "google-datetime",
- "type": "string"
- },
- "maximums": {
- "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
- "type": "array",
- "items": {
- "$ref": "DateRangeValues"
- }
- },
- "minimums": {
- "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
- "type": "array",
- "items": {
- "$ref": "DateRangeValues"
- }
- },
- "samplingSpaceSizes": {
- "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of\nsamples present, one entry per date range. If the results are not sampled\nthis field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
- },
- "totals": {
- "description": "For each requested date range, for the set of all rows that match\nthe query, every requested value format gets a total. The total\nfor a value format is computed by first totaling the metrics\nmentioned in the value format and then evaluating the value\nformat as a scalar expression. E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of all relevant ga:sessions) + 2)`.\nTotals are computed before pagination.",
- "type": "array",
- "items": {
- "$ref": "DateRangeValues"
- }
- },
- "samplesReadCounts": {
- "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of samples read, one entry per date range.\nIf the results are not sampled this field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
- }
- },
- "id": "ReportData"
- },
- "DimensionFilter": {
- "description": "Dimension filter specifies the filtering options on a dimension.",
- "type": "object",
- "properties": {
- "caseSensitive": {
- "description": "Should the match be case sensitive? Default is false.",
- "type": "boolean"
- },
- "dimensionName": {
- "description": "The dimension to filter on. A DimensionFilter must contain a dimension.",
- "type": "string"
- },
- "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`.",
- "The match expression is treated as a regular expression. All match types\nare not treated as regular expressions.",
- "Matches the value 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.",
- "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.",
- "Checks if the dimension is numerically greater than the match\nexpression. Read the description for `NUMERIC_EQUALS` for restrictions.",
- "Checks if the dimension is numerically less than the match expression.\nRead the description for `NUMERIC_EQUALS` for restrictions.",
- "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "REGEXP",
- "BEGINS_WITH",
- "ENDS_WITH",
- "PARTIAL",
- "EXACT",
- "NUMERIC_EQUAL",
- "NUMERIC_GREATER_THAN",
- "NUMERIC_LESS_THAN",
- "IN_LIST"
- ]
- },
- "not": {
- "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"
- }
- }
- },
- "id": "DimensionFilter"
- },
- "SegmentDimensionFilter": {
- "description": "Dimension filter specifies the filtering options on a dimension.",
- "type": "object",
- "properties": {
- "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",
- "BEGINS_WITH",
- "ENDS_WITH",
- "PARTIAL",
- "EXACT",
- "IN_LIST",
- "NUMERIC_LESS_THAN",
- "NUMERIC_GREATER_THAN",
- "NUMERIC_BETWEEN"
- ],
- "description": "The operator to use to match the dimension with the expressions.",
- "type": "string"
- },
- "expressions": {
- "description": "The list of expressions, only the first element is used for all operators",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "caseSensitive": {
- "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
- "type": "boolean"
- },
- "minComparisonValue": {
- "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": {
- "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": {
- "description": "The order type. The default orderType is `VALUE`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified order type will be treated as sort based on value.",
- "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
- "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
- "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
- "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
- "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
- ],
- "enum": [
- "ORDER_TYPE_UNSPECIFIED",
- "VALUE",
- "DELTA",
- "SMART",
- "HISTOGRAM_BUCKET",
- "DIMENSION_AS_INTEGER"
- ]
- },
- "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"
- },
- "Segment": {
- "description": "The segment definition, if the report needs to be segmented.\nA Segment is a subset of the Analytics data. For example, of the entire\nset of users, one Segment might be users from a particular country or city.",
- "type": "object",
- "properties": {
- "dynamicSegment": {
- "description": "A dynamic segment definition in the request.",
- "$ref": "DynamicSegment"
- },
- "segmentId": {
- "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
- "type": "string"
- }
- },
- "id": "Segment"
- },
- "SegmentSequenceStep": {
- "id": "SegmentSequenceStep",
- "description": "A segment sequence definition.",
- "type": "object",
- "properties": {
- "orFiltersForSegment": {
- "description": "A sequence is specified with a list of Or grouped filters which are\ncombined with `AND` operator.",
- "type": "array",
- "items": {
- "$ref": "OrFiltersForSegment"
- }
- },
- "matchType": {
- "enum": [
- "UNSPECIFIED_MATCH_TYPE",
- "PRECEDES",
- "IMMEDIATELY_PRECEDES"
- ],
- "description": "Specifies if the step immediately precedes or can be any time before the\nnext step.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified match type is treated as precedes.",
- "Operator indicates that the previous step precedes the next step.",
- "Operator indicates that the previous step immediately precedes the next\nstep."
- ]
- }
- }
- },
- "Metric": {
- "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
- "type": "object",
- "properties": {
- "alias": {
- "description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.",
- "type": "string"
- },
- "expression": {
- "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
- "type": "string"
- },
- "formattingType": {
- "enum": [
- "METRIC_TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "CURRENCY",
- "PERCENT",
- "TIME"
- ],
- "description": "Specifies how the metric expression should be formatted, for example\n`INTEGER`.",
- "type": "string",
- "enumDescriptions": [
- "Metric type is unspecified.",
- "Integer metric.",
- "Float metric.",
- "Currency metric.",
- "Percentage metric.",
- "Time metric in `HH:MM:SS` format."
- ]
- }
- },
- "id": "Metric"
- },
- "PivotValueRegion": {
- "description": "The metric values in the pivot region.",
- "type": "object",
- "properties": {
- "values": {
- "description": "The values of the metrics in each of the pivot regions.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PivotValueRegion"
- },
- "Report": {
- "description": "The data response corresponding to the request.",
- "type": "object",
- "properties": {
- "columnHeader": {
- "description": "The column headers.",
- "$ref": "ColumnHeader"
- },
- "data": {
- "description": "Response data.",
- "$ref": "ReportData"
- },
- "nextPageToken": {
- "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"
- }
- },
- "totalPivotGroupsCount": {
- "type": "integer",
- "description": "The total number of groups for this pivot.",
- "format": "int32"
- }
- },
- "id": "PivotHeader"
+ "id": "MetricHeaderEntry"
}
},
+ "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": "AnalyticsReporting",
"auth": {
"oauth2": {
@@ -1046,47 +1046,79 @@
"reports": {
"methods": {
"batchGet": {
- "description": "Returns the Analytics data.",
- "request": {
- "$ref": "GetReportsRequest"
- },
"response": {
"$ref": "GetReportsResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
+ "parameters": {},
"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"
+ "id": "analyticsreporting.reports.batchGet",
+ "request": {
+ "$ref": "GetReportsRequest"
+ },
+ "description": "Returns the Analytics data."
}
}
}
},
"parameters": {
- "callback": {
+ "oauth_token": {
"location": "query",
- "description": "JSONP",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "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"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1099,65 +1131,33 @@
"json",
"media",
"proto"
- ],
- "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."
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"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": {
+ "default": "true",
"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": {
- "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"
+ "description": "Pretty-print response."
}
},
"version": "v4",
"baseUrl": "https://analyticsreporting.googleapis.com/",
- "servicePath": "",
"description": "Accesses Analytics report data.",
- "kind": "discovery#restDescription"
+ "kind": "discovery#restDescription",
+ "servicePath": ""
}
diff --git a/api-list.json b/api-list.json
index 4aaef69..4f8fc7b 100644
--- a/api-list.json
+++ b/api-list.json
@@ -130,6 +130,21 @@
},
{
"kind": "discovery#directoryItem",
+ "id": "adexperiencereport:v1",
+ "name": "adexperiencereport",
+ "version": "v1",
+ "title": "Google Ad Experience Report API",
+ "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
+ "discoveryRestUrl": "https://adexperiencereport.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/ad-experience-report",
+ "preferred": true
+ },
+ {
+ "kind": "discovery#directoryItem",
"id": "admin:datatransfer_v1",
"name": "admin",
"version": "datatransfer_v1",
@@ -673,7 +688,7 @@
"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.",
+ "description": "Manages encryption for your cloud services the same way you do on-premises. 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",
@@ -1073,22 +1088,6 @@
},
{
"kind": "discovery#directoryItem",
- "id": "dfareporting:v2.6",
- "name": "dfareporting",
- "version": "v2.6",
- "title": "DCM/DFA Reporting And Trafficking API",
- "description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/dfareporting/v2.6/rest",
- "discoveryLink": "./apis/dfareporting/v2.6/rest",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
- "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
- },
- "documentationLink": "https://developers.google.com/doubleclick-advertisers/",
- "preferred": false
- },
- {
- "kind": "discovery#directoryItem",
"id": "dfareporting:v2.7",
"name": "dfareporting",
"version": "v2.7",
@@ -1255,7 +1254,7 @@
"name": "firebasedynamiclinks",
"version": "v1",
"title": "Firebase Dynamic Links API",
- "description": "Firebase Dynamic Links API enables third party developers to programmatically create and manage Dynamic Links.",
+ "description": "Programmatically creates and manages Firebase Dynamic Links.",
"discoveryRestUrl": "https://firebasedynamiclinks.googleapis.com/$discovery/rest?version=v1",
"icons": {
"x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
@@ -2573,15 +2572,14 @@
"id": "translate:v2",
"name": "translate",
"version": "v2",
- "title": "Translate API",
- "description": "Translates text from one language to another.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/translate/v2/rest",
- "discoveryLink": "./apis/translate/v2/rest",
+ "title": "Google Cloud Translation API",
+ "description": "The Google Cloud Translation API lets websites and programs integrate with Google Translate programmatically.",
+ "discoveryRestUrl": "https://translation.googleapis.com/$discovery/rest?version=v2",
"icons": {
- "x16": "https://www.google.com/images/icons/product/translate-16.png",
- "x32": "https://www.google.com/images/icons/product/translate-32.png"
+ "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/translate/v2/using_rest",
+ "documentationLink": "https://code.google.com/apis/language/translate/v2/getting_started.html",
"preferred": true
},
{
@@ -2602,6 +2600,21 @@
},
{
"kind": "discovery#directoryItem",
+ "id": "videointelligence:v1beta1",
+ "name": "videointelligence",
+ "version": "v1beta1",
+ "title": "Google Cloud Video Intelligence API",
+ "description": "Google Cloud Video Intelligence API.",
+ "discoveryRestUrl": "https://videointelligence.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://cloud.google.com/video-intelligence/docs/",
+ "preferred": true
+ },
+ {
+ "kind": "discovery#directoryItem",
"id": "vision:v1",
"name": "vision",
"version": "v1",
diff --git a/appengine/v1/appengine-api.json b/appengine/v1/appengine-api.json
index ea37910..e073269 100644
--- a/appengine/v1/appengine-api.json
+++ b/appengine/v1/appengine-api.json
@@ -1,68 +1,81 @@
{
- "id": "appengine:v1",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20170426",
- "title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "version_module": "True",
"resources": {
"apps": {
"methods": {
- "repair": {
+ "create": {
"httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
+ "parameterOrder": [],
"response": {
"$ref": "Operation"
},
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/apps/{appsId}:repair",
- "id": "appengine.apps.repair",
+ "flatPath": "v1/apps",
+ "id": "appengine.apps.create",
+ "path": "v1/apps",
+ "request": {
+ "$ref": "Application"
+ },
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/)."
+ },
+ "repair": {
"path": "v1/apps/{appsId}:repair",
+ "id": "appengine.apps.repair",
"request": {
"$ref": "RepairApplicationRequest"
},
- "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account."
- },
- "get": {
- "flatPath": "v1/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1/apps/{appsId}",
- "description": "Gets information about an application.",
- "httpMethod": "GET",
+ "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"
],
- "response": {
- "$ref": "Application"
- },
+ "httpMethod": "POST",
"parameters": {
"appsId": {
"location": "path",
- "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
"required": true,
"type": "string"
}
},
"scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}:repair"
+ },
+ "get": {
+ "flatPath": "v1/apps/{appsId}",
+ "path": "v1/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "description": "Gets information about an application.",
+ "response": {
+ "$ref": "Application"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
},
"patch": {
+ "id": "appengine.apps.patch",
+ "path": "v1/apps/{appsId}",
"request": {
"$ref": "Application"
},
@@ -91,37 +104,96 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1/apps/{appsId}"
- },
- "create": {
- "request": {
- "$ref": "Application"
- },
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps",
- "path": "v1/apps",
- "id": "appengine.apps.create"
+ "flatPath": "v1/apps/{appsId}"
}
},
"resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/locations",
+ "path": "v1/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list"
+ },
+ "get": {
+ "description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/locations/{locationsId}",
+ "path": "v1/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get"
+ }
+ }
+ },
"services": {
"methods": {
"delete": {
+ "httpMethod": "DELETE",
"response": {
"$ref": "Operation"
},
- "httpMethod": "DELETE",
"parameterOrder": [
"appsId",
"servicesId"
@@ -130,39 +202,33 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
},
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
"required": true,
"type": "string",
"location": "path"
}
},
"flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}",
"id": "appengine.apps.services.delete",
+ "path": "v1/apps/{appsId}/services/{servicesId}",
"description": "Deletes the specified service and all enclosed versions."
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
"response": {
"$ref": "ListServicesResponse"
},
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- },
"appsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"required": true,
@@ -173,6 +239,12 @@
"location": "query",
"description": "Continuation token for fetching the next page of results.",
"type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
}
},
"scopes": [
@@ -181,48 +253,44 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
"path": "v1/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
"description": "Lists all the services in the application."
},
"get": {
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.get",
+ "path": "v1/apps/{appsId}/services/{servicesId}",
"description": "Gets the current configuration of the specified service.",
- "response": {
- "$ref": "Service"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"appsId",
"servicesId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Service"
+ },
"parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
"servicesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get"
+ ]
},
"patch": {
- "request": {
- "$ref": "Service"
- },
- "description": "Updates the configuration of the specified service.",
"response": {
"$ref": "Operation"
},
@@ -231,18 +299,21 @@
"servicesId"
],
"httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"updateMask": {
+ "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"servicesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"appsId": {
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
@@ -256,18 +327,20 @@
"type": "boolean"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/apps/{appsId}/services/{servicesId}",
"path": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch"
+ "id": "appengine.apps.services.patch",
+ "description": "Updates the configuration of the specified service.",
+ "request": {
+ "$ref": "Service"
+ }
}
},
"resources": {
"versions": {
"methods": {
"create": {
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
"path": "v1/apps/{appsId}/services/{servicesId}/versions",
"id": "appengine.apps.services.versions.create",
"description": "Deploys code and resource files to a new version.",
@@ -287,10 +360,10 @@
],
"parameters": {
"servicesId": {
- "location": "path",
"description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"appsId": {
"description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
@@ -298,25 +371,24 @@
"type": "string",
"location": "path"
}
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions"
+ }
},
"delete": {
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "response": {
- "$ref": "Operation"
- },
"httpMethod": "DELETE",
"parameters": {
"servicesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
@@ -325,10 +397,10 @@
"location": "path"
},
"versionsId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -340,7 +412,10 @@
"description": "Deletes an existing Version resource."
},
"list": {
- "httpMethod": "GET",
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list",
+ "description": "Lists the versions of a service.",
"response": {
"$ref": "ListVersionsResponse"
},
@@ -348,6 +423,7 @@
"appsId",
"servicesId"
],
+ "httpMethod": "GET",
"parameters": {
"servicesId": {
"description": "Part of `parent`. See documentation of `appsId`.",
@@ -362,9 +438,9 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"description": "Maximum results to return per page.",
@@ -386,14 +462,13 @@
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions",
- "description": "Lists the versions of a service."
+ ]
},
"get": {
+ "id": "appengine.apps.services.versions.get",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
"description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
+ "httpMethod": "GET",
"response": {
"$ref": "Version"
},
@@ -402,47 +477,43 @@
"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": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
},
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"view": {
- "location": "query",
"enum": [
"BASIC",
"FULL"
],
"description": "Controls the set of fields returned in the Get response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
"type": "string"
}
},
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get"
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
},
"patch": {
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
"id": "appengine.apps.services.versions.patch",
"path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
"description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
@@ -462,69 +533,73 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"updateMask": {
- "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "required": true,
"type": "string"
},
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
}
- }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
}
},
"resources": {
"instances": {
"methods": {
"delete": {
- "response": {
- "$ref": "Operation"
- },
+ "id": "appengine.apps.services.versions.instances.delete",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "description": "Stops a running instance.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"appsId",
"servicesId",
"versionsId",
"instancesId"
],
- "httpMethod": "DELETE",
+ "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/versions/v1/instances/instance-1.",
- "required": true,
"type": "string",
"location": "path"
},
- "instancesId": {
+ "appsId": {
"location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
"required": true,
"type": "string"
},
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
"versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -532,31 +607,20 @@
"location": "path"
}
},
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "description": "Stops a running instance."
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
},
"list": {
- "id": "appengine.apps.services.versions.instances.list",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
"description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "response": {
- "$ref": "ListInstancesResponse"
- },
+ "httpMethod": "GET",
"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,
@@ -575,6 +639,12 @@
"location": "query"
},
"versionsId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "servicesId": {
"location": "path",
"description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
@@ -586,33 +656,22 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "id": "appengine.apps.services.versions.instances.list"
},
"get": {
- "description": "Gets instance information.",
"httpMethod": "GET",
- "response": {
- "$ref": "Instance"
- },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId",
"instancesId"
],
+ "response": {
+ "$ref": "Instance"
+ },
"parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"appsId": {
"location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
@@ -620,6 +679,18 @@
"type": "string"
},
"instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "servicesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -633,13 +704,10 @@
],
"flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
"id": "appengine.apps.services.versions.instances.get",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "description": "Gets instance information."
},
"debug": {
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
"httpMethod": "POST",
"parameterOrder": [
"appsId",
@@ -654,12 +722,6 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -677,11 +739,21 @@
"required": true,
"type": "string",
"location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
}
},
"flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
"id": "appengine.apps.services.versions.instances.debug",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug"
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ }
}
}
}
@@ -692,48 +764,50 @@
"operations": {
"methods": {
"list": {
- "path": "v1/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [
"appsId"
],
- "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"
- },
- "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"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/apps/{appsId}/operations"
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
+ "path": "v1/apps/{appsId}/operations",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
},
"get": {
+ "path": "v1/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"response": {
"$ref": "Operation"
@@ -745,10 +819,10 @@
"httpMethod": "GET",
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. The name of the operation resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"operationsId": {
"location": "path",
@@ -762,88 +836,7 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/apps/{appsId}/operations/{operationsId}",
- "path": "v1/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
- }
- }
- },
- "locations": {
- "methods": {
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/apps/{appsId}/locations",
- "path": "v1/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list"
- },
- "get": {
- "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": {
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "path": "v1/apps/{appsId}/locations/{locationsId}"
+ "flatPath": "v1/apps/{appsId}/operations/{operationsId}"
}
}
}
@@ -851,12 +844,24 @@
}
},
"parameters": {
- "callback": {
+ "fields": {
"location": "query",
- "description": "JSONP",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -865,17 +870,9 @@
"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": [
@@ -883,16 +880,22 @@
"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"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
"type": "string"
},
"quotaUser": {
@@ -901,956 +904,38 @@
"type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
+ "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.",
"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"
}
},
"schemas": {
- "UrlDispatchRule": {
- "properties": {
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "service": {
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- },
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule",
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object"
- },
- "ListVersionsResponse": {
- "properties": {
- "versions": {
- "description": "The versions belonging to the requested service.",
- "type": "array",
- "items": {
- "$ref": "Version"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse",
- "description": "Response message for Versions.ListVersions.",
- "type": "object"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "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": {
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "format": "google-duration",
- "type": "string"
- },
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
- },
- "diskUtilization": {
- "description": "Target scaling by disk usage.",
- "$ref": "DiskUtilization"
- },
- "minPendingLatency": {
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AutomaticScaling"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- },
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- }
- },
- "id": "Library"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListLocationsResponse"
- },
- "ContainerInfo": {
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "image": {
- "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
- "type": "string"
- }
- },
- "id": "ContainerInfo"
- },
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable 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": {
- "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": {
- "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": "Executes a script to handle the request that matches this URL pattern.",
- "$ref": "ScriptHandler"
- },
- "urlRegex": {
- "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
- "type": "string"
- },
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- },
- "staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
- }
- },
- "id": "UrlMap"
- },
- "EndpointsApiService": {
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
- "type": "string"
- }
- },
- "id": "EndpointsApiService"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
- "securityLevel": {
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ]
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string"
- },
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- }
- },
- "id": "ApiConfigHandler"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "response": {
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- }
- },
- "id": "Operation"
- },
- "StaticFilesHandler": {
- "properties": {
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
- "format": "google-duration",
- "type": "string"
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
- "type": "string"
- }
- },
- "id": "StaticFilesHandler",
- "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"
- },
- "DiskUtilization": {
- "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",
- "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": {
- "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"
- },
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
- "properties": {
- "aggregationWindowLength": {
- "description": "Period of time over which CPU utilization is calculated.",
- "format": "google-duration",
- "type": "string"
- },
- "targetUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "CpuUtilization"
- },
- "IdentityAwareProxy": {
- "properties": {
- "oauth2ClientSecret": {
- "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- },
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
- },
- "enabled": {
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
- "type": "boolean"
- }
- },
- "id": "IdentityAwareProxy",
- "description": "Identity-Aware Proxy",
- "type": "object"
- },
- "Status": {
- "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"
- }
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status",
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc 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": {
- "split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
- },
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Service"
- },
- "ListOperationsResponse": {
- "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": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "errorCode": {
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ],
- "description": "Error condition this handler applies to.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
- },
- "Network": {
- "properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "subnetworkName": {
- "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
- "type": "string"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "type": "object"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "defaultHostname": {
- "description": "Hostname used to reach this application, as resolved by App Engine.@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"
- },
- "codeBucket": {
- "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "gcrDomain": {
- "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "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"
- },
- "locationId": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "servingStatus": {
- "enumDescriptions": [
- "Serving status is unspecified.",
- "Application is serving.",
- "Application has been disabled by the user.",
- "Application has been disabled by the system."
- ],
- "enum": [
- "UNSPECIFIED",
- "SERVING",
- "USER_DISABLED",
- "SYSTEM_DISABLED"
- ],
- "description": "Serving status of this application.",
- "type": "string"
- }
- },
- "id": "Application"
- },
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
- "properties": {
- "vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "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"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
- "type": "string"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "availability": {
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "startTime": {
- "description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Instance"
- },
"LivenessCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
"type": "object",
"properties": {
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "format": "uint32",
- "type": "integer"
- },
- "initialDelay": {
- "description": "The initial delay before starting to execute the checks.",
- "format": "google-duration",
- "type": "string"
- },
"path": {
"description": "The request path.",
"type": "string"
@@ -1868,47 +953,29 @@
"description": "Interval between health checks.",
"format": "google-duration",
"type": "string"
+ },
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "initialDelay": {
+ "description": "The initial delay before starting to execute the checks.",
+ "format": "google-duration",
+ "type": "string"
}
},
"id": "LivenessCheck"
},
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
"type": "object",
"properties": {
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- }
- },
- "id": "Location"
- },
- "NetworkUtilization": {
- "properties": {
- "targetReceivedPacketsPerSecond": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- },
"targetSentBytesPerSecond": {
"description": "Target bytes sent per second.",
"format": "int32",
@@ -1923,16 +990,54 @@
"description": "Target bytes received per second.",
"format": "int32",
"type": "integer"
+ },
+ "targetReceivedPacketsPerSecond": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "NetworkUtilization",
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object"
+ "id": "NetworkUtilization"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object"
+ }
+ },
+ "id": "Location"
},
"HealthCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"type": "object",
"properties": {
+ "timeout": {
+ "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",
@@ -1960,11 +1065,6 @@
"description": "Interval between health checks.",
"format": "google-duration",
"type": "string"
- },
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "format": "google-duration",
- "type": "string"
}
},
"id": "HealthCheck"
@@ -1973,25 +1073,6 @@
"description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
"type": "object",
"properties": {
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- },
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
- },
"successThreshold": {
"description": "Number of consecutive successful checks required before receiving traffic.",
"format": "uint32",
@@ -2000,20 +1081,39 @@
"host": {
"description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
"type": "string"
+ },
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "path": {
+ "description": "The request path.",
+ "type": "string"
}
},
"id": "ReadinessCheck"
},
"DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object",
"properties": {
"sshKey": {
"description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
"type": "string"
}
},
- "id": "DebugInstanceRequest",
- "description": "Request message for Instances.DebugInstance.",
- "type": "object"
+ "id": "DebugInstanceRequest"
},
"OperationMetadataV1Beta5": {
"description": "Metadata for the given google.longrunning.Operation.",
@@ -2045,12 +1145,10 @@
"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": {
- "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",
@@ -2070,8 +1168,8 @@
"$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"
+ "$ref": "ManualScaling",
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
},
"name": {
"description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
@@ -2111,9 +1209,13 @@
"description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
"type": "string"
},
+ "runtimeApiVersion": {
+ "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
+ "type": "string"
+ },
"deployment": {
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
- "$ref": "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",
@@ -2121,10 +1223,21 @@
"type": "string"
},
"resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
+ "description": "Machine resources for this version. Only applicable for VM runtimes.",
+ "$ref": "Resources"
},
"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": {
@@ -2140,18 +1253,7 @@
"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."
- ]
+ }
},
"errorHandlers": {
"description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
@@ -2204,15 +1306,15 @@
"$ref": "LivenessCheck"
},
"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.",
- "type": "object"
+ }
},
"env": {
"description": "App Engine execution environment for this version.Defaults to standard.",
@@ -2226,7 +1328,9 @@
}
}
},
- "id": "Version"
+ "id": "Version",
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
+ "type": "object"
},
"RepairApplicationRequest": {
"description": "Request message for 'Applications.RepairApplication'.",
@@ -2234,6 +1338,25 @@
"properties": {},
"id": "RepairApplicationRequest"
},
+ "FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "type": "object",
+ "properties": {
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "id": "FileInfo"
+ },
"ScriptHandler": {
"properties": {
"scriptPath": {
@@ -2245,37 +1368,10 @@
"description": "Executes a script to handle the request that matches the URL pattern.",
"type": "object"
},
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
- "type": "string"
- },
- "sourceUrl": {
- "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- },
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
- "type": "string"
- }
- },
- "id": "FileInfo"
- },
"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"
@@ -2289,6 +1385,14 @@
"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"
@@ -2314,12 +1418,12 @@
"type": "string"
},
"allocations": {
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
- }
+ },
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
}
},
"id": "TrafficSplit"
@@ -2383,6 +1487,8 @@
"type": "object"
},
"Resources": {
+ "description": "Machine resources for a version.",
+ "type": "object",
"properties": {
"volumes": {
"description": "User specified volumes.",
@@ -2407,36 +1513,38 @@
"type": "number"
}
},
- "id": "Resources",
- "description": "Machine resources for a version.",
- "type": "object"
+ "id": "Resources"
},
"Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
"properties": {
"zip": {
- "$ref": "ZipInfo",
- "description": "The zip file for this deployment, if this is a zip deployment."
+ "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"
},
"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"
+ "id": "Deployment",
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object"
},
"Volume": {
"description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
"type": "object",
"properties": {
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
+ },
"sizeGb": {
"description": "Volume size in gigabytes.",
"format": "double",
@@ -2445,15 +1553,13 @@
"name": {
"description": "Unique name for the volume.",
"type": "string"
- },
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
}
},
"id": "Volume"
},
"ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
@@ -2467,16 +1573,907 @@
}
}
},
- "id": "ListInstancesResponse",
- "description": "Response message for Instances.ListInstances.",
+ "id": "ListInstancesResponse"
+ },
+ "UrlDispatchRule": {
+ "properties": {
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ },
+ "service": {
+ "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ },
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule",
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
"type": "object"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object",
+ "properties": {
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "type": "array",
+ "items": {
+ "$ref": "Version"
+ }
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListVersionsResponse"
+ },
+ "ApiEndpointHandler": {
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ApiEndpointHandler",
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "type": "object"
+ },
+ "ZipInfo": {
+ "properties": {
+ "sourceUrl": {
+ "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ },
+ "filesCount": {
+ "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"
+ }
+ },
+ "id": "ZipInfo",
+ "description": "The zip file information for a zip deployment.",
+ "type": "object"
+ },
+ "AutomaticScaling": {
+ "properties": {
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxPendingLatency": {
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "$ref": "CpuUtilization"
+ }
+ },
+ "id": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object"
+ },
+ "Library": {
+ "properties": {
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ }
+ },
+ "id": "Library",
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "ContainerInfo": {
+ "properties": {
+ "image": {
+ "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
+ "type": "string"
+ }
+ },
+ "id": "ContainerInfo",
+ "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
+ "type": "object"
+ },
+ "RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetRequestCountPerSecond": {
+ "description": "Target requests per second.",
+ "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": {
+ "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": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
+ },
+ "redirectHttpResponseCode": {
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ],
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string"
+ },
+ "authFailAction": {
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string"
+ },
+ "script": {
+ "description": "Executes a script to handle the request that matches this URL pattern.",
+ "$ref": "ScriptHandler"
+ },
+ "urlRegex": {
+ "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ }
+ },
+ "id": "UrlMap"
+ },
+ "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": {
+ "properties": {
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string"
+ },
+ "authFailAction": {
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ]
+ },
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ },
+ "login": {
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ]
+ }
+ },
+ "id": "ApiConfigHandler",
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object"
+ },
+ "StaticFilesHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ }
+ },
+ "id": "StaticFilesHandler"
+ },
+ "BasicScaling": {
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "type": "object",
+ "properties": {
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "idleTimeout": {
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "BasicScaling"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetReadBytesPerSecond": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadOpsPerSecond": {
+ "description": "Target ops read per seconds.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSecond": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSecond": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DiskUtilization"
+ },
+ "CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "type": "object",
+ "properties": {
+ "aggregationWindowLength": {
+ "description": "Period of time over which CPU utilization is calculated.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "targetUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "CpuUtilization"
+ },
+ "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"
+ },
+ "Status": {
+ "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"
+ }
+ },
+ "id": "Status",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
+ },
+ "ManualScaling": {
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "type": "object",
+ "properties": {
+ "instances": {
+ "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ManualScaling"
+ },
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "type": "object",
+ "properties": {
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "id": "LocationMetadata"
+ },
+ "Service": {
+ "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Service"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadata"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object",
+ "properties": {
+ "errorCode": {
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "description": "Error condition this handler applies to.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorHandler"
+ },
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object",
+ "properties": {
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "codeBucket": {
+ "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
+ "type": "string"
+ },
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ }
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "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": {
+ "description": "Serving status of this application.",
+ "type": "string",
+ "enumDescriptions": [
+ "Serving status is unspecified.",
+ "Application is serving.",
+ "Application has been disabled by the user.",
+ "Application has been disabled by the system."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "SERVING",
+ "USER_DISABLED",
+ "SYSTEM_DISABLED"
+ ]
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Application"
+ },
+ "Network": {
+ "properties": {
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "subnetworkName": {
+ "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ }
+ },
+ "id": "Network",
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "type": "object"
+ },
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object",
+ "properties": {
+ "vmDebugEnabled": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ]
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startTime": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Instance"
}
},
- "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"version": "v1",
"baseUrl": "https://appengine.googleapis.com/",
"auth": {
@@ -2495,11 +2492,18 @@
}
},
"servicePath": "",
- "kind": "discovery#restDescription",
"description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "kind": "discovery#restDescription",
"rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "appengine",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "revision": "20170525",
+ "id": "appengine:v1",
+ "title": "Google App Engine Admin API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "version_module": "True"
}
diff --git a/appengine/v1/appengine-gen.go b/appengine/v1/appengine-gen.go
index 522d95e..f8a99d1 100644
--- a/appengine/v1/appengine-gen.go
+++ b/appengine/v1/appengine-gen.go
@@ -2055,7 +2055,7 @@
// 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
+// error detail types in the package google.rpc that can be used for
// common error conditions.Language mappingThe Status message is the
// logical representation of the error model, but it is not necessarily
// the actual wire format. When the Status message is exposed in
@@ -2070,7 +2070,7 @@
// 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.
+// have a Status message for error reporting.
// 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.
@@ -2463,6 +2463,11 @@
// Runtime: Desired runtime. Example: python27.
Runtime string `json:"runtime,omitempty"`
+ // RuntimeApiVersion: The version of the API in the given runtime
+ // environment. Please see the app.yaml reference for valid values at
+ // https://cloud.google.com/appengine/docs/standard/<language>/config/appref
+ RuntimeApiVersion string `json:"runtimeApiVersion,omitempty"`
+
// ServingStatus: 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
@@ -3672,9 +3677,14 @@
// 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.
+// UNIMPLEMENTED.NOTE: the name binding allows API services to override
+// the binding to use different resource name schemes, such as
+// users/*/operations. To override the binding, API services can add a
+// binding such as "/v1/{name=users/*}/operations" to their service
+// configuration. For backwards compatibility, the default name includes
+// the operations collection id, however overriding users must ensure
+// the name binding is the parent resource, without the operations
+// collection id.
func (r *AppsOperationsService) List(appsId string) *AppsOperationsListCall {
c := &AppsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -3796,7 +3806,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
// "flatPath": "v1/apps/{appsId}/operations",
// "httpMethod": "GET",
// "id": "appengine.apps.operations.list",
@@ -3805,7 +3815,7 @@
// ],
// "parameters": {
// "appsId": {
- // "description": "Part of `name`. The name of the operation collection.",
+ // "description": "Part of `name`. The name of the operation's parent resource.",
// "location": "path",
// "required": true,
// "type": "string"
diff --git a/appengine/v1alpha/appengine-api.json b/appengine/v1alpha/appengine-api.json
index b8da8b1..365c2ad 100644
--- a/appengine/v1alpha/appengine-api.json
+++ b/appengine/v1alpha/appengine-api.json
@@ -1,40 +1,24 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
"description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"servicePath": "",
+ "kind": "discovery#restDescription",
"rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
- "revision": "20170426",
+ "revision": "20170525",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"id": "appengine:v1alpha",
"title": "Google App Engine Admin API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"apps": {
"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"
},
@@ -42,11 +26,6 @@
"appsId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"filter": {
"location": "query",
@@ -54,15 +33,15 @@
"type": "string"
},
"appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation collection.",
+ "description": "Part of `name`. The name of the operation's parent resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"pageToken": {
- "location": "query",
"description": "The standard list page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -71,12 +50,17 @@
"type": "integer"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1alpha/apps/{appsId}/operations",
"path": "v1alpha/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list"
+ "id": "appengine.apps.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
},
"get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"response": {
"$ref": "Operation"
},
@@ -85,36 +69,35 @@
"operationsId"
],
"httpMethod": "GET",
- "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"
],
+ "parameters": {
+ "operationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
"flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
"path": "v1alpha/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
+ "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": {
- "path": "v1alpha/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
"description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
@@ -123,17 +106,16 @@
"appsId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"appsId": {
"location": "path",
@@ -145,47 +127,50 @@
"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"
+ "flatPath": "v1alpha/apps/{appsId}/locations",
+ "path": "v1alpha/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list"
},
"get": {
- "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
- "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
"description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
"parameterOrder": [
"appsId",
"locationsId"
],
- "response": {
- "$ref": "Location"
- },
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"appsId": {
"description": "Part of `name`. Resource name for the location.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
+ "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get"
}
}
}
@@ -193,17 +178,6 @@
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
@@ -214,12 +188,9 @@
"type": "string",
"location": "query"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -228,11 +199,19 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -241,17 +220,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "default": "json"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"access_token": {
"description": "OAuth access token.",
@@ -259,102 +233,43 @@
"location": "query"
},
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
+ "default": "true",
"location": "query"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
+ },
+ "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"
}
},
"schemas": {
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "OperationMetadataExperimental": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "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"
- },
"OperationMetadataV1Beta5": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
"method": {
"description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
@@ -368,23 +283,22 @@
"description": "Timestamp that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
}
},
"id": "OperationMetadataV1Beta5"
},
"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.",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.",
"type": "array",
@@ -395,11 +309,40 @@
},
"type": "object"
}
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
"id": "Status"
},
+ "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"
+ },
"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",
@@ -410,27 +353,7 @@
"type": "boolean"
}
},
- "id": "LocationMetadata",
- "description": "Metadata for the given google.cloud.location.Location.",
- "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"
+ "id": "LocationMetadata"
},
"OperationMetadataV1Beta": {
"description": "Metadata for the given google.longrunning.Operation.",
@@ -473,8 +396,6 @@
"id": "OperationMetadataV1Beta"
},
"Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
"properties": {
"labels": {
"additionalProperties": {
@@ -500,32 +421,22 @@
"type": "object"
}
},
- "id": "Location"
+ "id": "Location",
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object"
},
"OperationMetadataV1": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "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"
@@ -538,12 +449,56 @@
"description": "Time that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "OperationMetadataV1"
},
- "Operation": {
+ "ListOperationsResponse": {
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
"done": {
"description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
"type": "boolean"
@@ -559,48 +514,93 @@
"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"
+ "id": "Operation"
},
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
"type": "string"
},
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
}
},
- "id": "ListOperationsResponse"
+ "id": "OperationMetadata"
+ },
+ "OperationMetadataExperimental": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "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"
}
},
+ "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": "v1alpha",
- "baseUrl": "https://appengine.googleapis.com/"
+ "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"
+ }
+ }
+ }
+ }
}
diff --git a/appengine/v1alpha/appengine-gen.go b/appengine/v1alpha/appengine-gen.go
index 2fe4259..542f063 100644
--- a/appengine/v1alpha/appengine-gen.go
+++ b/appengine/v1alpha/appengine-gen.go
@@ -583,7 +583,7 @@
// 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
+// error detail types in the package google.rpc that can be used for
// common error conditions.Language mappingThe Status message is the
// logical representation of the error model, but it is not necessarily
// the actual wire format. When the Status message is exposed in
@@ -598,7 +598,7 @@
// 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.
+// have a Status message for error reporting.
// 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.
@@ -1159,9 +1159,14 @@
// 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.
+// UNIMPLEMENTED.NOTE: the name binding allows API services to override
+// the binding to use different resource name schemes, such as
+// users/*/operations. To override the binding, API services can add a
+// binding such as "/v1/{name=users/*}/operations" to their service
+// configuration. For backwards compatibility, the default name includes
+// the operations collection id, however overriding users must ensure
+// the name binding is the parent resource, without the operations
+// collection id.
func (r *AppsOperationsService) List(appsId string) *AppsOperationsListCall {
c := &AppsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -1283,7 +1288,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
// "flatPath": "v1alpha/apps/{appsId}/operations",
// "httpMethod": "GET",
// "id": "appengine.apps.operations.list",
@@ -1292,7 +1297,7 @@
// ],
// "parameters": {
// "appsId": {
- // "description": "Part of `name`. The name of the operation collection.",
+ // "description": "Part of `name`. The name of the operation's parent resource.",
// "location": "path",
// "required": true,
// "type": "string"
diff --git a/appengine/v1beta/appengine-api.json b/appengine/v1beta/appengine-api.json
index dad4e7c..4cda40c 100644
--- a/appengine/v1beta/appengine-api.json
+++ b/appengine/v1beta/appengine-api.json
@@ -1,19 +1,49 @@
{
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "revision": "20170525",
+ "id": "appengine:v1beta",
+ "title": "Google App Engine Admin API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"apps": {
"methods": {
+ "repair": {
+ "flatPath": "v1beta/apps/{appsId}:repair",
+ "id": "appengine.apps.repair",
+ "path": "v1beta/apps/{appsId}:repair",
+ "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
+ "request": {
+ "$ref": "RepairApplicationRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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"
+ }
+ }
+ },
"get": {
- "flatPath": "v1beta/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1beta/apps/{appsId}",
"description": "Gets information about an application.",
- "httpMethod": "GET",
"response": {
"$ref": "Application"
},
"parameterOrder": [
"appsId"
],
+ "httpMethod": "GET",
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
@@ -26,46 +56,45 @@
"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"
},
"patch": {
- "flatPath": "v1beta/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1beta/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"
},
- "httpMethod": "PATCH",
- "parameterOrder": [
- "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.",
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "parameterOrder": [
+ "appsId"
],
+ "httpMethod": "PATCH",
"parameters": {
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
"appsId": {
"description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}",
+ "path": "v1beta/apps/{appsId}",
+ "id": "appengine.apps.patch"
},
"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"
},
@@ -77,606 +106,23 @@
],
"flatPath": "v1beta/apps",
"path": "v1beta/apps",
- "id": "appengine.apps.create"
- },
- "repair": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}:repair",
- "path": "v1beta/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.",
+ "id": "appengine.apps.create",
"request": {
- "$ref": "RepairApplicationRequest"
- }
+ "$ref": "Application"
+ },
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/)."
}
},
"resources": {
- "locations": {
- "methods": {
- "list": {
- "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.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "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"
- },
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "get": {
- "flatPath": "v1beta/apps/{appsId}/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": {
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "authorizedCertificates": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "description": "Deletes the specified SSL certificate."
- },
- "list": {
- "description": "Lists all SSL certificates the user is authorized to administer.",
- "response": {
- "$ref": "ListAuthorizedCertificatesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list"
- },
- "get": {
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the GET response.",
- "type": "string"
- },
- "authorizedCertificatesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
- "description": "Gets the specified SSL certificate."
- },
- "patch": {
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string"
- },
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "create": {
- "description": "Uploads the specified SSL certificate.",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.create",
- "path": "v1beta/apps/{appsId}/authorizedCertificates"
- }
- }
- },
"services": {
- "methods": {
- "list": {
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListServicesResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/services",
- "path": "v1beta/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
- "description": "Lists all the services in the application."
- },
- "get": {
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get",
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "description": "Gets the current configuration of the specified service.",
- "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"
- ],
- "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"
- }
- }
- },
- "patch": {
- "request": {
- "$ref": "Service"
- },
- "description": "Updates the configuration of the specified service.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "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": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
- "path": "v1beta/apps/{appsId}/services/{servicesId}"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "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": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete",
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "description": "Deletes the specified service and all enclosed versions."
- }
- },
"resources": {
"versions": {
"methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "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"
- ]
- },
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "description": "Lists the versions of a service."
- },
- "get": {
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "view": {
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "request": {
- "$ref": "Version"
- },
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment."
- },
"create": {
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
+ "description": "Deploys code and resource files to a new version.",
"request": {
"$ref": "Version"
},
- "description": "Deploys code and resource files to a new version.",
"response": {
"$ref": "Operation"
},
@@ -685,28 +131,28 @@
"servicesId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"servicesId": {
+ "location": "path",
"description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "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": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create"
},
"delete": {
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
"description": "Deletes an existing Version resource.",
"response": {
"$ref": "Operation"
@@ -717,12 +163,15 @@
"versionsId"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"servicesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"appsId": {
"location": "path",
@@ -737,43 +186,224 @@
"location": "path"
}
},
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete"
+ },
+ "list": {
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list",
+ "description": "Lists the versions of a service.",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "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": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions"
+ },
+ "get": {
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Version"
+ },
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "patch": {
+ "description": "Updates the specified 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"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource 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": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.patch",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
}
},
"resources": {
"instances": {
"methods": {
- "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).",
+ "delete": {
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.delete",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "description": "Stops a running instance.",
+ "httpMethod": "DELETE",
"response": {
- "$ref": "ListInstancesResponse"
+ "$ref": "Operation"
},
"parameterOrder": [
"appsId",
"servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "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"
+ ]
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
"versionsId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"servicesId": {
"location": "path",
"description": "Part of `parent`. See documentation of `appsId`.",
@@ -787,17 +417,29 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "versionsId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "required": true,
"type": "string",
- "location": "query"
+ "location": "path"
}
},
"flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "id": "appengine.apps.services.versions.instances.list",
"path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "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": {
- "description": "Gets instance information.",
"response": {
"$ref": "Instance"
},
@@ -815,23 +457,23 @@
],
"parameters": {
"versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
},
- "appsId": {
+ "servicesId": {
"location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
},
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
"instancesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -841,9 +483,14 @@
},
"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"
+ "id": "appengine.apps.services.versions.instances.get",
+ "description": "Gets instance information."
},
"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"
},
@@ -871,102 +518,52 @@
"location": "path"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
"required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
"type": "string",
"location": "path"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
}
},
"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"
- }
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "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.debug"
}
}
}
}
}
- }
- },
- "authorizedDomains": {
+ },
"methods": {
"list": {
- "flatPath": "v1beta/apps/{appsId}/authorizedDomains",
- "path": "v1beta/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list",
- "description": "Lists all domains the user is authorized to administer.",
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
"parameterOrder": [
"appsId"
],
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"pageToken": {
- "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -975,38 +572,181 @@
"type": "integer"
}
},
+ "flatPath": "v1beta/apps/{appsId}/services",
+ "path": "v1beta/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
+ "description": "Lists all the services in the application."
+ },
+ "get": {
+ "description": "Gets the current configuration of the specified service.",
+ "response": {
+ "$ref": "Service"
+ },
+ "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 `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"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.get"
+ },
+ "patch": {
+ "description": "Updates the configuration of the specified service.",
+ "request": {
+ "$ref": "Service"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "migrateTraffic": {
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
+ "type": "boolean",
+ "location": "query"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.delete",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "description": "Deletes the specified service and all enclosed versions."
+ }
+ }
+ },
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "description": "Lists all domains the user is authorized to administer.",
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedDomains",
+ "path": "v1beta/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list"
}
}
},
"operations": {
"methods": {
"list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
"parameterOrder": [
"appsId"
],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
"appsId": {
- "description": "Part of `name`. The name of the operation collection.",
+ "description": "Part of `name`. The name of the operation's parent resource.",
"required": true,
"type": "string",
"location": "path"
@@ -1015,20 +755,25 @@
"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/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."
+ "id": "appengine.apps.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
},
"get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"httpMethod": "GET",
"parameterOrder": [
"appsId",
@@ -1044,10 +789,10 @@
],
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. The name of the operation resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"operationsId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -1058,153 +803,14 @@
},
"flatPath": "v1beta/apps/{appsId}/operations/{operationsId}",
"id": "appengine.apps.operations.get",
- "path": "v1beta/apps/{appsId}/operations/{operationsId}"
+ "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."
}
}
},
"domainMappings": {
"methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListDomainMappingsResponse"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "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}/domainMappings",
- "id": "appengine.apps.domainMappings.list",
- "path": "v1beta/apps/{appsId}/domainMappings",
- "description": "Lists the domain mappings on an application."
- },
- "get": {
- "description": "Gets the specified domain mapping.",
- "response": {
- "$ref": "DomainMapping"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string"
- },
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get"
- },
- "patch": {
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch"
- },
- "create": {
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/domainMappings",
- "path": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create"
- },
"delete": {
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete",
"description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
"response": {
"$ref": "Operation"
@@ -1225,12 +831,412 @@
"location": "path"
},
"domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.delete"
+ },
+ "list": {
+ "id": "appengine.apps.domainMappings.list",
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "description": "Lists the domain mappings on an application.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDomainMappingsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/domainMappings"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "DomainMapping"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.get",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "description": "Gets the specified domain mapping."
+ },
+ "patch": {
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "domainMappingsId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.patch",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}"
+ },
+ "create": {
+ "id": "appengine.apps.domainMappings.create",
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/domainMappings"
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "path": "v1beta/apps/{appsId}/locations",
+ "description": "Lists information about the supported locations for this service."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "parameters": {
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get",
+ "path": "v1beta/apps/{appsId}/locations/{locationsId}",
+ "description": "Get information about a location."
+ }
+ }
+ },
+ "authorizedCertificates": {
+ "methods": {
+ "create": {
+ "description": "Uploads the specified SSL certificate.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates"
+ },
+ "delete": {
+ "description": "Deletes the specified SSL certificate.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "parameters": {
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListAuthorizedCertificatesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "description": "Lists all SSL certificates the user is authorized to administer."
+ },
+ "get": {
+ "description": "Gets the specified SSL certificate.",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "authorizedCertificatesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "description": "Controls the set of fields returned in the GET response.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get"
+ },
+ "patch": {
+ "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "authorizedCertificatesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.patch"
}
}
}
@@ -1238,25 +1244,47 @@
}
},
"parameters": {
- "callback": {
- "description": "JSONP",
+ "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"
},
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
+ "uploadType": {
"location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "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",
@@ -1269,7 +1297,11 @@
"json",
"media",
"proto"
- ],
+ ]
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
"type": "string"
},
"key": {
@@ -1277,11 +1309,6 @@
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "access_token": {
- "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",
@@ -1294,572 +1321,32 @@
"default": "true"
},
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
- },
- "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"
}
},
"schemas": {
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "ListAuthorizedCertificatesResponse": {
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
- "type": "object",
- "properties": {
- "certificates": {
- "description": "The SSL certificates the user is authorized to administer.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedCertificate"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListAuthorizedCertificatesResponse"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
- },
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object",
- "properties": {
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
- "type": "string"
- }
- },
- "id": "SslSettings"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "errorCode": {
- "description": "Error condition this handler applies to.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ]
- },
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "locationId": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "servingStatus": {
- "description": "Serving status of this application.",
- "type": "string",
- "enumDescriptions": [
- "Serving status is unspecified.",
- "Application is serving.",
- "Application has been disabled by the user.",
- "Application has been disabled by the system."
- ],
- "enum": [
- "UNSPECIFIED",
- "SERVING",
- "USER_DISABLED",
- "SYSTEM_DISABLED"
- ]
- },
- "defaultHostname": {
- "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "codeBucket": {
- "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
- "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"
- }
- },
- "id": "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"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "subnetworkName": {
- "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
- "type": "string"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network"
- },
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
- "properties": {
- "availability": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "startTime": {
- "description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "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"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "Instance"
- },
- "LivenessCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "type": "object",
- "properties": {
- "host": {
- "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "successThreshold": {
- "description": "Number of consecutive successful checks required before considering the VM healthy.",
- "format": "uint32",
- "type": "integer"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- },
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "format": "uint32",
- "type": "integer"
- },
- "initialDelay": {
- "description": "The initial delay before starting to execute the checks.",
- "format": "google-duration",
- "type": "string"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
- }
- },
- "id": "LivenessCheck"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
- }
- },
- "id": "Location"
- },
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable 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",
- "type": "integer"
- },
- "targetSentPacketsPerSecond": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedBytesPerSecond": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization"
- },
- "HealthCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "type": "object",
- "properties": {
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "unhealthyThreshold": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "healthyThreshold": {
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "restartThreshold": {
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "format": "uint32",
- "type": "integer"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "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"
- },
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "successThreshold": {
- "description": "Number of consecutive successful checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "ReadinessCheck"
- },
- "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"
- },
- "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": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta5"
- },
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
"type": "object",
"properties": {
+ "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"
+ }
+ },
"automaticScaling": {
"$ref": "AutomaticScaling",
"description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
@@ -1870,8 +1357,8 @@
"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"
+ "$ref": "HealthCheck",
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
},
"threadsafe": {
"description": "Whether multiple requests can be dispatched to this version at once.",
@@ -1882,20 +1369,20 @@
"$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"
+ "$ref": "ManualScaling",
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
},
"name": {
"description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
"type": "string"
},
"apiConfig": {
- "$ref": "ApiConfigHandler",
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
+ "$ref": "ApiConfigHandler"
},
"endpointsApiService": {
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.",
- "$ref": "EndpointsApiService"
+ "$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.",
@@ -1923,6 +1410,10 @@
"STOPPED"
]
},
+ "runtimeApiVersion": {
+ "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
+ "type": "string"
+ },
"deployment": {
"$ref": "Deployment",
"description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
@@ -1932,26 +1423,10 @@
"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": {
- "type": "string",
"enum": [
"INBOUND_SERVICE_UNSPECIFIED",
"INBOUND_SERVICE_MAIL",
@@ -1962,8 +1437,24 @@
"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.",
@@ -1989,8 +1480,8 @@
"type": "string"
},
"basicScaling": {
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "$ref": "BasicScaling"
+ "$ref": "BasicScaling",
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
},
"runtime": {
"description": "Desired runtime. Example: python27.",
@@ -2025,17 +1516,6 @@
},
"description": "Metadata settings that are supplied to this version to enable beta runtime features.",
"type": "object"
- },
- "env": {
- "description": "App Engine execution environment for this version.Defaults to standard.",
- "type": "string"
- },
- "handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "UrlMap"
- }
}
},
"id": "Version"
@@ -2061,6 +1541,17 @@
},
"id": "CertificateRawData"
},
+ "BuildInfo": {
+ "description": "Google Cloud Container Builder build information.",
+ "type": "object",
+ "properties": {
+ "cloudBuildId": {
+ "description": "The Google Cloud Container Builder build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"",
+ "type": "string"
+ }
+ },
+ "id": "BuildInfo"
+ },
"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",
@@ -2095,10 +1586,6 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
- "type": "string"
- },
"insertTime": {
"description": "Time that this operation was created.@OutputOnly",
"format": "google-datetime",
@@ -2116,6 +1603,10 @@
"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"
}
},
"id": "OperationMetadataExperimental"
@@ -2124,13 +1615,13 @@
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
"type": "object",
"properties": {
- "id": {
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
- "type": "string"
- },
"name": {
"description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
"type": "string"
+ },
+ "id": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "type": "string"
}
},
"id": "AuthorizedDomain"
@@ -2182,14 +1673,14 @@
"format": "google-datetime",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
"ephemeralMessage": {
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
@@ -2229,13 +1720,17 @@
"type": "object",
"properties": {
"zip": {
- "description": "The zip file for this deployment, if this is a zip deployment.",
- "$ref": "ZipInfo"
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
},
"container": {
"$ref": "ContainerInfo",
"description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
},
+ "build": {
+ "$ref": "BuildInfo",
+ "description": "Google Cloud Container Builder build information."
+ },
"files": {
"additionalProperties": {
"$ref": "FileInfo"
@@ -2279,10 +1774,6 @@
"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",
@@ -2291,13 +1782,15 @@
"name": {
"description": "Unique name for the volume.",
"type": "string"
+ },
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
}
},
"id": "Volume"
},
"ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
@@ -2311,22 +1804,24 @@
}
}
},
- "id": "ListInstancesResponse"
+ "id": "ListInstancesResponse",
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object"
},
"ListDomainMappingsResponse": {
"description": "Response message for DomainMappings.ListDomainMappings.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
"domainMappings": {
"description": "The domain mappings for the application.",
"type": "array",
"items": {
"$ref": "DomainMapping"
}
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
}
},
"id": "ListDomainMappingsResponse"
@@ -2354,16 +1849,16 @@
"description": "Response message for Versions.ListVersions.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
"versions": {
"description": "The versions belonging to the requested service.",
"type": "array",
"items": {
"$ref": "Version"
}
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
}
},
"id": "ListVersionsResponse"
@@ -2386,9 +1881,24 @@
},
"id": "ListAuthorizedDomainsResponse"
},
- "DomainMapping": {
- "description": "A domain serving an App Engine application.",
+ "ApiEndpointHandler": {
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ApiEndpointHandler",
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
"type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "DomainMapping": {
"properties": {
"name": {
"description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
@@ -2410,39 +1920,23 @@
}
}
},
- "id": "DomainMapping"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
+ "id": "DomainMapping",
+ "description": "A domain serving an App Engine application.",
+ "type": "object"
},
"AutomaticScaling": {
"description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
"type": "object",
"properties": {
- "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"
},
+ "standardSchedulerSettings": {
+ "description": "Scheduler settings for standard environment.",
+ "$ref": "StandardSchedulerSettings"
+ },
"requestUtilization": {
"$ref": "RequestUtilization",
"description": "Target scaling by request utilization."
@@ -2466,16 +1960,16 @@
"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"
},
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "format": "google-duration",
+ "type": "string"
+ },
"maxPendingLatency": {
"description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
"format": "google-duration",
@@ -2486,8 +1980,13 @@
"$ref": "CpuUtilization"
},
"diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
+ "description": "Target scaling by disk usage.",
+ "$ref": "DiskUtilization"
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
}
},
"id": "AutomaticScaling"
@@ -2496,14 +1995,14 @@
"description": "The zip file information for a zip deployment.",
"type": "object",
"properties": {
+ "sourceUrl": {
+ "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ },
"filesCount": {
"description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
"format": "int32",
"type": "integer"
- },
- "sourceUrl": {
- "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
}
},
"id": "ZipInfo"
@@ -2512,14 +2011,6 @@
"description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
"type": "object",
"properties": {
- "displayName": {
- "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
- "type": "string"
- },
- "certificateRawData": {
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.",
- "$ref": "CertificateRawData"
- },
"visibleDomainMappings": {
"description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly",
"type": "array",
@@ -2551,6 +2042,14 @@
"id": {
"description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
"type": "string"
+ },
+ "displayName": {
+ "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ "type": "string"
+ },
+ "certificateRawData": {
+ "$ref": "CertificateRawData",
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
}
},
"id": "AuthorizedCertificate"
@@ -2560,8 +2059,6 @@
"type": "object",
"properties": {
"type": {
- "description": "Resource record type. Example: AAAA.",
- "type": "string",
"enumDescriptions": [
"An A resource record. Data is an IPv4 address.",
"An AAAA resource record. Data is an IPv6 address.",
@@ -2571,7 +2068,9 @@
"A",
"AAAA",
"CNAME"
- ]
+ ],
+ "description": "Resource record type. Example: AAAA.",
+ "type": "string"
},
"rrdata": {
"description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
@@ -2603,30 +2102,30 @@
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Location"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
"id": "ListLocationsResponse"
},
"ContainerInfo": {
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "type": "object",
"properties": {
"image": {
"description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
"type": "string"
}
},
- "id": "ContainerInfo"
+ "id": "ContainerInfo",
+ "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
+ "type": "object"
},
"RequestUtilization": {
"description": "Target scaling by request utilization. Only applicable for VM runtimes.",
@@ -2645,29 +2144,52 @@
},
"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": {
- "login": {
- "description": "Level of login required to access this resource.",
+ "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": "Executes a script to handle the request that matches this URL pattern.",
+ "$ref": "ScriptHandler"
+ },
+ "urlRegex": {
+ "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ },
+ "login": {
+ "enumDescriptions": [
"Not specified. LOGIN_OPTIONAL is assumed.",
"Does not require that the user is signed in.",
"If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
@@ -2678,11 +2200,13 @@
"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."
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
},
"staticFiles": {
"description": "Returns the contents of a file, such as an image, as the response.",
@@ -2705,81 +2229,56 @@
"REDIRECT_HTTP_RESPONSE_CODE_303",
"REDIRECT_HTTP_RESPONSE_CODE_307"
]
- },
- "securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ]
- },
- "authFailAction": {
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
- },
- "script": {
- "description": "Executes a script to handle the request that matches this URL pattern.",
- "$ref": "ScriptHandler"
- },
- "urlRegex": {
- "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
}
},
"id": "UrlMap"
},
+ "EndpointsApiService": {
+ "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ },
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
+ "type": "string"
+ }
+ },
+ "id": "EndpointsApiService"
+ },
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
- "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 contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
"done": {
"description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
"type": "boolean"
},
"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"
- }
+ },
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
}
},
"id": "Operation"
@@ -2788,14 +2287,27 @@
"description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
"type": "object",
"properties": {
- "securityLevel": {
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ "login": {
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
],
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ]
+ },
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
+ },
+ "securityLevel": {
"enum": [
"SECURE_UNSPECIFIED",
"SECURE_DEFAULT",
@@ -2804,45 +2316,32 @@
"SECURE_ALWAYS"
],
"description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ]
},
"authFailAction": {
+ "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"
]
},
"script": {
"description": "Path to the script from the application root directory.",
"type": "string"
- },
- "login": {
- "description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ]
- },
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
}
},
"id": "ApiConfigHandler"
@@ -2851,25 +2350,12 @@
"description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
"type": "object",
"properties": {
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
- "format": "google-duration",
- "type": "string"
- },
"httpHeaders": {
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "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.",
@@ -2882,6 +2368,19 @@
"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"
@@ -2890,16 +2389,6 @@
"description": "Target scaling by disk usage. Only applicable for VM runtimes.",
"type": "object",
"properties": {
- "targetWriteOpsPerSecond": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteBytesPerSecond": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- },
"targetReadBytesPerSecond": {
"description": "Target bytes read per second.",
"format": "int32",
@@ -2909,6 +2398,16 @@
"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"
@@ -2931,8 +2430,6 @@
"id": "BasicScaling"
},
"CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
"properties": {
"aggregationWindowLength": {
"description": "Period of time over which CPU utilization is calculated.",
@@ -2945,12 +2442,18 @@
"type": "number"
}
},
- "id": "CpuUtilization"
+ "id": "CpuUtilization",
+ "description": "Target scaling by CPU usage.",
+ "type": "object"
},
"Status": {
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc 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.",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.",
"type": "array",
@@ -2966,10 +2469,6 @@
"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"
@@ -2978,14 +2477,6 @@
"description": "Identity-Aware Proxy",
"type": "object",
"properties": {
- "oauth2ClientSecret": {
- "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- },
"oauth2ClientSecretSha256": {
"description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
"type": "string"
@@ -2993,6 +2484,14 @@
"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"
@@ -3013,13 +2512,13 @@
"description": "Metadata for the given google.cloud.location.Location.",
"type": "object",
"properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
"standardEnvironmentAvailable": {
"description": "App Engine Standard Environment is available in the given location.@OutputOnly",
"type": "boolean"
+ },
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
}
},
"id": "LocationMetadata"
@@ -3028,74 +2527,615 @@
"description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
"type": "object",
"properties": {
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "type": "string"
+ },
"name": {
"description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
},
"split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
- },
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
- "type": "string"
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
+ "$ref": "TrafficSplit"
}
},
"id": "Service"
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Operation"
}
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
+ },
+ "OperationMetadata": {
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
},
- "nextPageToken": {
- "description": "The standard List next-page token.",
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
"type": "string"
}
},
- "id": "ListOperationsResponse"
+ "id": "OperationMetadata",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
+ "ListAuthorizedCertificatesResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "certificates": {
+ "description": "The SSL certificates the user is authorized to administer.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthorizedCertificate"
+ }
+ }
+ },
+ "id": "ListAuthorizedCertificatesResponse",
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
+ "type": "object"
+ },
+ "ErrorHandler": {
+ "properties": {
+ "errorCode": {
+ "description": "Error condition this handler applies to.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ]
+ },
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorHandler",
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1"
+ },
+ "SslSettings": {
+ "properties": {
+ "certificateId": {
+ "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
+ "type": "string"
+ }
+ },
+ "id": "SslSettings",
+ "description": "SSL configuration for a DomainMapping resource.",
+ "type": "object"
+ },
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object",
+ "properties": {
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "codeBucket": {
+ "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
+ "type": "string"
+ },
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ }
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "servingStatus": {
+ "enumDescriptions": [
+ "Serving status is unspecified.",
+ "Application is serving.",
+ "Application has been disabled by the user.",
+ "Application has been disabled by the system."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "SERVING",
+ "USER_DISABLED",
+ "SYSTEM_DISABLED"
+ ],
+ "description": "Serving status of this application.",
+ "type": "string"
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "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"
+ }
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "subnetworkName": {
+ "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ }
+ },
+ "id": "Network"
+ },
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object",
+ "properties": {
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "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"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@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"
+ ]
+ },
+ "startTime": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "vmDebugEnabled": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Instance"
+ },
+ "LivenessCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
+ "type": "object",
+ "properties": {
+ "initialDelay": {
+ "description": "The initial delay before starting to execute the checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "path": {
+ "description": "The request path.",
+ "type": "string"
+ },
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before considering the VM healthy.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "id": "LivenessCheck"
+ },
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetSentBytesPerSecond": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSecond": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedBytesPerSecond": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSecond": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
+ "properties": {
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "labels": {
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "type": "string"
+ }
+ },
+ "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.",
+ "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"
+ },
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "healthyThreshold": {
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "timeout": {
+ "description": "Time before the health check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "HealthCheck"
+ },
+ "ReadinessCheck": {
+ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
+ "type": "object",
+ "properties": {
+ "host": {
+ "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before receiving traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "path": {
+ "description": "The request path.",
+ "type": "string"
+ }
+ },
+ "id": "ReadinessCheck"
+ },
+ "StandardSchedulerSettings": {
+ "description": "Scheduler settings for standard environment.",
+ "type": "object",
+ "properties": {
+ "targetThroughputUtilization": {
+ "description": "Target throughput utilization ratio to maintain when scaling",
+ "format": "double",
+ "type": "number"
+ },
+ "targetCpuUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "StandardSchedulerSettings"
+ },
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object",
+ "properties": {
+ "sshKey": {
+ "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
+ "type": "string"
+ }
+ },
+ "id": "DebugInstanceRequest"
+ },
+ "OperationMetadataV1Beta5": {
+ "properties": {
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta5",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
}
},
- "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"version": "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"
+ },
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
}
}
}
},
- "servicePath": "",
"description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "servicePath": "",
"kind": "discovery#restDescription",
"rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "appengine",
- "batchPath": "batch",
- "id": "appengine:v1beta",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20170426",
- "title": "Google App Engine Admin API",
- "ownerName": "Google",
- "discoveryVersion": "v1"
+ "batchPath": "batch"
}
diff --git a/appengine/v1beta/appengine-gen.go b/appengine/v1beta/appengine-gen.go
index 21847b2..6622329 100644
--- a/appengine/v1beta/appengine-gen.go
+++ b/appengine/v1beta/appengine-gen.go
@@ -550,6 +550,10 @@
// RequestUtilization: Target scaling by request utilization.
RequestUtilization *RequestUtilization `json:"requestUtilization,omitempty"`
+ // StandardSchedulerSettings: Scheduler settings for standard
+ // environment.
+ StandardSchedulerSettings *StandardSchedulerSettings `json:"standardSchedulerSettings,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "CoolDownPeriod") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -609,6 +613,35 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// BuildInfo: Google Cloud Container Builder build information.
+type BuildInfo struct {
+ // CloudBuildId: The Google Cloud Container Builder build id. Example:
+ // "f966068f-08b2-42c8-bdfe-74137dff2bf9"
+ CloudBuildId string `json:"cloudBuildId,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CloudBuildId") 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. "CloudBuildId") 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 *BuildInfo) MarshalJSON() ([]byte, error) {
+ type noMethod BuildInfo
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// CertificateRawData: An SSL certificate obtained from a certificate
// authority.
type CertificateRawData struct {
@@ -769,6 +802,9 @@
// Deployment: Code and application artifacts used to deploy a version
// to App Engine.
type Deployment struct {
+ // Build: Google Cloud Container Builder build information.
+ Build *BuildInfo `json:"build,omitempty"`
+
// Container: The Docker image for the container that runs the version.
// Only applicable for instances running in the App Engine flexible
// environment.
@@ -782,7 +818,7 @@
// Zip: The zip file for this deployment, if this is a zip deployment.
Zip *ZipInfo `json:"zip,omitempty"`
- // ForceSendFields is a list of field names (e.g. "Container") to
+ // ForceSendFields is a list of field names (e.g. "Build") 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
@@ -790,8 +826,8 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Container") to include in
- // API requests with the JSON null value. By default, fields with empty
+ // NullFields is a list of field names (e.g. "Build") 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.
@@ -2417,6 +2453,58 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// StandardSchedulerSettings: Scheduler settings for standard
+// environment.
+type StandardSchedulerSettings struct {
+ // TargetCpuUtilization: Target CPU utilization ratio to maintain when
+ // scaling.
+ TargetCpuUtilization float64 `json:"targetCpuUtilization,omitempty"`
+
+ // TargetThroughputUtilization: Target throughput utilization ratio to
+ // maintain when scaling
+ TargetThroughputUtilization float64 `json:"targetThroughputUtilization,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "TargetCpuUtilization") 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. "TargetCpuUtilization") 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 *StandardSchedulerSettings) MarshalJSON() ([]byte, error) {
+ type noMethod StandardSchedulerSettings
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+func (s *StandardSchedulerSettings) UnmarshalJSON(data []byte) error {
+ type noMethod StandardSchedulerSettings
+ var s1 struct {
+ TargetCpuUtilization gensupport.JSONFloat64 `json:"targetCpuUtilization"`
+ TargetThroughputUtilization gensupport.JSONFloat64 `json:"targetThroughputUtilization"`
+ *noMethod
+ }
+ s1.noMethod = (*noMethod)(s)
+ if err := json.Unmarshal(data, &s1); err != nil {
+ return err
+ }
+ s.TargetCpuUtilization = float64(s1.TargetCpuUtilization)
+ s.TargetThroughputUtilization = float64(s1.TargetThroughputUtilization)
+ return nil
+}
+
// StaticFilesHandler: 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
@@ -2492,7 +2580,7 @@
// 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
+// error detail types in the package google.rpc that can be used for
// common error conditions.Language mappingThe Status message is the
// logical representation of the error model, but it is not necessarily
// the actual wire format. When the Status message is exposed in
@@ -2507,7 +2595,7 @@
// 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.
+// have a Status message for error reporting.
// 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.
@@ -2901,6 +2989,11 @@
// Runtime: Desired runtime. Example: python27.
Runtime string `json:"runtime,omitempty"`
+ // RuntimeApiVersion: The version of the API in the given runtime
+ // environment. Please see the app.yaml reference for valid values at
+ // https://cloud.google.com/appengine/docs/standard/<language>/config/appref
+ RuntimeApiVersion string `json:"runtimeApiVersion,omitempty"`
+
// ServingStatus: 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
@@ -5854,9 +5947,14 @@
// 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.
+// UNIMPLEMENTED.NOTE: the name binding allows API services to override
+// the binding to use different resource name schemes, such as
+// users/*/operations. To override the binding, API services can add a
+// binding such as "/v1/{name=users/*}/operations" to their service
+// configuration. For backwards compatibility, the default name includes
+// the operations collection id, however overriding users must ensure
+// the name binding is the parent resource, without the operations
+// collection id.
func (r *AppsOperationsService) List(appsId string) *AppsOperationsListCall {
c := &AppsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -5978,7 +6076,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
// "flatPath": "v1beta/apps/{appsId}/operations",
// "httpMethod": "GET",
// "id": "appengine.apps.operations.list",
@@ -5987,7 +6085,7 @@
// ],
// "parameters": {
// "appsId": {
- // "description": "Part of `name`. The name of the operation collection.",
+ // "description": "Part of `name`. The name of the operation's parent resource.",
// "location": "path",
// "required": true,
// "type": "string"
diff --git a/appengine/v1beta4/appengine-api.json b/appengine/v1beta4/appengine-api.json
index 44849d9..794c9e2 100644
--- a/appengine/v1beta4/appengine-api.json
+++ b/appengine/v1beta4/appengine-api.json
@@ -1,74 +1,143 @@
{
+ "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"
+ }
+ }
+ }
+ },
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "servicePath": "",
+ "kind": "discovery#restDescription",
"rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
- "id": "appengine:v1beta4",
+ "revision": "20170525",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20170426",
+ "id": "appengine:v1beta4",
"title": "Google App Engine Admin API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"apps": {
+ "methods": {
+ "get": {
+ "description": "Gets information about an application.",
+ "response": {
+ "$ref": "Application"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "ensureResourcesExist": {
+ "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}",
+ "path": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.get"
+ },
+ "patch": {
+ "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"
+ },
+ "mask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}",
+ "path": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)",
+ "request": {
+ "$ref": "Application"
+ }
+ },
+ "create": {
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
+ "request": {
+ "$ref": "Application"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta4/apps",
+ "path": "v1beta4/apps",
+ "id": "appengine.apps.create"
+ }
+ },
"resources": {
"modules": {
"methods": {
- "delete": {
- "description": "Deletes the specified module and all enclosed versions.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "required": true,
- "type": "string"
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.delete"
- },
"get": {
- "response": {
- "$ref": "Module"
- },
"parameterOrder": [
"appsId",
"modulesId"
],
"httpMethod": "GET",
+ "response": {
+ "$ref": "Module"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
},
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
"required": true,
"type": "string",
"location": "path"
@@ -80,55 +149,51 @@
"description": "Gets the current configuration of the specified module."
},
"list": {
- "httpMethod": "GET",
"response": {
"$ref": "ListModulesResponse"
},
"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"
- ],
+ "httpMethod": "GET",
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
"description": "Maximum results to return per page.",
"format": "int32",
"type": "integer",
"location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1beta4/apps/{appsId}/modules",
- "id": "appengine.apps.modules.list",
"path": "v1beta4/apps/{appsId}/modules",
+ "id": "appengine.apps.modules.list",
"description": "Lists all the modules in the application."
},
"patch": {
- "request": {
- "$ref": "Module"
+ "response": {
+ "$ref": "Operation"
},
- "description": "Updates the configuration of the specified module.",
- "httpMethod": "PATCH",
"parameterOrder": [
"appsId",
"modulesId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PATCH",
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
@@ -142,10 +207,10 @@
"type": "boolean"
},
"modulesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"mask": {
"description": "Standard field mask for the set of fields to be updated.",
@@ -158,30 +223,96 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
"id": "appengine.apps.modules.patch",
+ "request": {
+ "$ref": "Module"
+ },
+ "description": "Updates the configuration of the specified module."
+ },
+ "delete": {
+ "description": "Deletes the specified module and all enclosed versions.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.delete",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}"
}
},
"resources": {
"versions": {
"methods": {
- "delete": {
+ "create": {
+ "description": "Deploys code and resource files to a new version.",
+ "request": {
+ "$ref": "Version"
+ },
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "id": "appengine.apps.modules.versions.create"
+ },
+ "delete": {
"httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"modulesId",
"versionsId"
],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"modulesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -193,33 +324,44 @@
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
+ "required": true,
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
"id": "appengine.apps.modules.versions.delete",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
"description": "Deletes an existing version."
},
"get": {
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "id": "appengine.apps.modules.versions.get",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
"description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "response": {
- "$ref": "Version"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"appsId",
"modulesId",
"versionsId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Version"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"modulesId": {
"location": "path",
@@ -234,25 +376,20 @@
"type": "string"
},
"view": {
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string",
"location": "query",
"enum": [
"BASIC",
"FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string"
+ ]
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.get"
+ }
},
"list": {
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "id": "appengine.apps.modules.versions.list",
"description": "Lists the versions of a module.",
"response": {
"$ref": "ListVersionsResponse"
@@ -269,10 +406,10 @@
],
"parameters": {
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"pageToken": {
"location": "query",
@@ -300,16 +437,9 @@
"FULL"
]
}
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "id": "appengine.apps.modules.versions.list"
+ }
},
"patch": {
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "request": {
- "$ref": "Version"
- },
"response": {
"$ref": "Operation"
},
@@ -350,92 +480,18 @@
},
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.patch"
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "id": "appengine.apps.modules.versions.create",
+ "id": "appengine.apps.modules.versions.patch",
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
"request": {
"$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version."
+ }
}
},
"resources": {
"instances": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.modules.versions.instances.delete",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Stops a running instance."
- },
"get": {
+ "description": "Gets instance information.",
"response": {
"$ref": "Instance"
},
@@ -446,24 +502,19 @@
"instancesId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
"required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
"type": "string",
"location": "path"
},
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
"modulesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
@@ -477,13 +528,16 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.modules.versions.instances.get",
- "description": "Gets instance information."
+ "id": "appengine.apps.modules.versions.instances.get"
},
"list": {
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
"response": {
"$ref": "ListInstancesResponse"
},
@@ -495,15 +549,15 @@
"httpMethod": "GET",
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"pageToken": {
- "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"description": "Maximum results to return per page.",
@@ -512,10 +566,10 @@
"location": "query"
},
"modulesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -531,9 +585,14 @@
],
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.modules.versions.instances.list"
+ "id": "appengine.apps.modules.versions.instances.list",
+ "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
},
"debug": {
+ "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"
},
@@ -545,6 +604,18 @@
],
"httpMethod": "POST",
"parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
"modulesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -556,7 +627,30 @@
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
- },
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.modules.versions.instances.debug"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
"required": true,
@@ -568,18 +662,24 @@
"required": true,
"type": "string",
"location": "path"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.modules.versions.instances.debug",
- "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."
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.modules.versions.instances.delete",
+ "description": "Stops a running instance."
}
}
}
@@ -590,7 +690,6 @@
"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"
},
@@ -598,89 +697,6 @@
"appsId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "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": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/operations",
- "path": "v1beta4/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list"
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "path": "v1beta4/apps/{appsId}/operations/{operationsId}"
- }
- }
- },
- "locations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"filter": {
"location": "query",
@@ -688,7 +704,7 @@
"type": "string"
},
"appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "description": "Part of `name`. The name of the operation's parent resource.",
"required": true,
"type": "string",
"location": "path"
@@ -705,32 +721,110 @@
"type": "integer"
}
},
- "flatPath": "v1beta4/apps/{appsId}/locations",
- "path": "v1beta4/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "description": "Lists information about the supported locations for this service."
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/operations",
+ "path": "v1beta4/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
},
"get": {
- "description": "Get information about a location.",
+ "response": {
+ "$ref": "Operation"
+ },
"httpMethod": "GET",
"parameterOrder": [
"appsId",
- "locationsId"
+ "operationsId"
],
- "response": {
- "$ref": "Location"
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ },
+ "operationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "list": {
+ "flatPath": "v1beta4/apps/{appsId}/locations",
+ "path": "v1beta4/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "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": {
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ }
+ }
+ },
+ "get": {
+ "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"
+ "type": "string",
+ "location": "path"
},
"locationsId": {
"location": "path",
@@ -739,123 +833,73 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}",
+ "path": "v1beta4/apps/{appsId}/locations/{locationsId}",
"id": "appengine.apps.locations.get",
- "path": "v1beta4/apps/{appsId}/locations/{locationsId}"
+ "description": "Get information about a location."
}
}
}
- },
- "methods": {
- "get": {
- "description": "Gets information about an application.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Application"
- },
- "parameterOrder": [
- "appsId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "ensureResourcesExist": {
- "location": "query",
- "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.",
- "type": "boolean"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1beta4/apps/{appsId}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "mask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1beta4/apps/{appsId}",
- "request": {
- "$ref": "Application"
- },
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)"
- },
- "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": "v1beta4/apps",
- "id": "appengine.apps.create",
- "path": "v1beta4/apps"
- }
}
}
},
"parameters": {
- "quotaUser": {
+ "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": "Available 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",
+ "location": "query"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"location": "query",
@@ -863,16 +907,16 @@
"type": "boolean",
"default": "true"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"callback": {
"description": "JSONP",
"type": "string",
@@ -890,507 +934,9 @@
],
"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"
}
},
"schemas": {
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "instances": {
- "description": "The instances belonging to the requested version.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
- }
- },
- "id": "ListInstancesResponse"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "errorCode": {
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ],
- "description": "Error condition this handler applies to.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
- },
- "Network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "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"
- },
- "location": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "defaultHostname": {
- "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Application"
- },
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
- "properties": {
- "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"
- },
- "availability": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "uint32",
- "type": "integer"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "startTimestamp": {
- "description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmUnlocked": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Instance"
- },
- "UrlDispatchRule": {
- "properties": {
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "module": {
- "description": "Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: default.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule",
- "description": "Rules to match an HTTP request and dispatch that request to a module.",
- "type": "object"
- },
- "Module": {
- "properties": {
- "id": {
- "description": "Relative name of the module within the application. Example: default.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module.",
- "$ref": "TrafficSplit"
- }
- },
- "id": "Module",
- "description": "A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.",
- "type": "object"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "versions": {
- "description": "The versions belonging to the requested module.",
- "type": "array",
- "items": {
- "$ref": "Version"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "AutomaticScaling": {
- "properties": {
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "$ref": "NetworkUtilization",
- "description": "Target scaling by network usage."
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "format": "google-duration",
- "type": "string"
- },
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
- },
- "minPendingLatency": {
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "requestUtilization": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "minIdleInstances": {
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object"
- },
- "StaticDirectoryHandler": {
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.",
- "type": "object",
- "properties": {
- "expiration": {
- "description": "Time a static file served by this handler should be cached.",
- "format": "google-duration",
- "type": "string"
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- },
- "directory": {
- "description": "Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- }
- },
- "id": "StaticDirectoryHandler"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
- }
- },
- "id": "Location"
- },
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetSentPacketsPerSec": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentBytesPerSec": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedPacketsPerSec": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedBytesPerSec": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization"
- },
"HealthCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"type": "object",
@@ -1431,20 +977,7 @@
},
"id": "HealthCheck"
},
- "DebugInstanceRequest": {
- "properties": {
- "sshKey": {
- "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
- "type": "string"
- }
- },
- "id": "DebugInstanceRequest",
- "description": "Request message for Instances.DebugInstance.",
- "type": "object"
- },
"SourceReference": {
- "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
- "type": "object",
"properties": {
"revisionId": {
"description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
@@ -1455,7 +988,20 @@
"type": "string"
}
},
- "id": "SourceReference"
+ "id": "SourceReference",
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
+ "type": "object"
+ },
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object",
+ "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"
},
"OperationMetadataV1Beta5": {
"description": "Metadata for the given google.longrunning.Operation.",
@@ -1487,34 +1033,34 @@
"id": "OperationMetadataV1Beta5"
},
"Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object",
"properties": {
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- },
"name": {
"description": "Name of the library. Example: \"django\".",
"type": "string"
+ },
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
}
},
- "id": "Library",
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object"
+ "id": "Library"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Location"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
"id": "ListLocationsResponse"
@@ -1534,6 +1080,76 @@
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a module.",
"type": "object",
"properties": {
+ "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": {
+ "$ref": "Deployment",
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
+ },
+ "runtimeApiVersion": {
+ "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
+ "type": "string"
+ },
+ "resources": {
+ "description": "Machine resources for this version. Only applicable for VM runtimes.",
+ "$ref": "Resources"
+ },
+ "inboundServices": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ],
+ "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "INBOUND_SERVICE_UNSPECIFIED",
+ "INBOUND_SERVICE_MAIL",
+ "INBOUND_SERVICE_MAIL_BOUNCE",
+ "INBOUND_SERVICE_XMPP_ERROR",
+ "INBOUND_SERVICE_XMPP_MESSAGE",
+ "INBOUND_SERVICE_XMPP_SUBSCRIBE",
+ "INBOUND_SERVICE_XMPP_PRESENCE",
+ "INBOUND_SERVICE_CHANNEL_PRESENCE",
+ "INBOUND_SERVICE_WARMUP"
+ ],
+ "type": "string"
+ }
+ },
+ "errorHandlers": {
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "ErrorHandler"
+ }
+ },
"defaultExpiration": {
"description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
"format": "google-duration",
@@ -1546,15 +1162,15 @@
"$ref": "Library"
}
},
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
"creationTime": {
"description": "Time that this version was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
"basicScaling": {
"description": "A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
"$ref": "BasicScaling"
@@ -1575,8 +1191,8 @@
"type": "object"
},
"network": {
- "$ref": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes."
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "$ref": "Network"
},
"betaSettings": {
"additionalProperties": {
@@ -1613,82 +1229,16 @@
"type": "boolean"
},
"manualScaling": {
- "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "$ref": "ManualScaling"
+ "$ref": "ManualScaling",
+ "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
},
"name": {
"description": "Full path to the Version resource in the API. Example: apps/myapp/modules/default/versions/v1.@OutputOnly",
"type": "string"
},
"apiConfig": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
- },
- "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": {
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ],
- "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ]
- },
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
- },
- "resources": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
- },
- "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."
- ]
- },
- "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": "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."
}
},
"id": "Version"
@@ -1714,25 +1264,14 @@
"description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
"type": "object",
"properties": {
- "redirectHttpResponseCode": {
- "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": [
@@ -1741,18 +1280,9 @@
"Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
"Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
"Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
]
},
"authFailAction": {
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
"enumDescriptions": [
"Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
"Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
@@ -1762,17 +1292,21 @@
"AUTH_FAIL_ACTION_UNSPECIFIED",
"AUTH_FAIL_ACTION_REDIRECT",
"AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string"
},
"script": {
- "$ref": "ScriptHandler",
- "description": "Executes a script to handle the request that matches this URL pattern."
+ "description": "Executes a script to handle the request that matches this URL pattern.",
+ "$ref": "ScriptHandler"
},
"urlRegex": {
"description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
"type": "string"
},
"login": {
+ "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.",
@@ -1784,49 +1318,78 @@
"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."
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
},
"staticDirectory": {
- "$ref": "StaticDirectoryHandler",
- "description": "Serves the entire contents of a directory as static files.This attribute is deprecated. You can mimic the behavior of static directories using static files."
+ "description": "Serves the entire contents of a directory as static files.This attribute is deprecated. You can mimic the behavior of static directories using static files.",
+ "$ref": "StaticDirectoryHandler"
},
"staticFiles": {
"$ref": "StaticFilesHandler",
"description": "Returns the contents of a file, such as an image, as the response."
+ },
+ "redirectHttpResponseCode": {
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ]
}
},
"id": "UrlMap"
},
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
- "script": {
- "description": "Path to the script from the application root directory.",
+ "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"
},
- "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"
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "Operation"
+ },
+ "ApiConfigHandler": {
+ "properties": {
"url": {
"description": "URL to serve the endpoint at.",
"type": "string"
@@ -1850,77 +1413,78 @@
]
},
"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",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ]
+ },
+ "script": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
+ },
+ "login": {
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ]
}
},
- "id": "ApiConfigHandler"
+ "id": "ApiConfigHandler",
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object"
},
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
+ "FileInfo": {
"properties": {
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
},
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically 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"
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
},
- "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.",
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
"type": "string"
}
},
- "id": "Operation"
+ "id": "FileInfo",
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "type": "object"
+ },
+ "ScriptHandler": {
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object"
},
"StaticFilesHandler": {
"description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
"type": "object",
"properties": {
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
"expiration": {
"description": "Time a static file served by this handler should be cached.",
"format": "google-duration",
@@ -1936,40 +1500,26 @@
},
"description": "HTTP headers to use for all responses from these URLs.",
"type": "object"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "type": "string"
+ },
+ "path": {
+ "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
}
},
"id": "StaticFilesHandler"
},
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ScriptHandler"
- },
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
- "type": "string"
- },
- "sourceUrl": {
- "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- },
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
- "type": "string"
- }
- },
- "id": "FileInfo"
- },
"BasicScaling": {
"description": "A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
"type": "object",
@@ -1988,6 +1538,8 @@
"id": "BasicScaling"
},
"DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "type": "object",
"properties": {
"targetReadBytesPerSec": {
"description": "Target bytes read per second.",
@@ -2010,9 +1562,7 @@
"type": "integer"
}
},
- "id": "DiskUtilization",
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object"
+ "id": "DiskUtilization"
},
"OperationMetadataExperimental": {
"description": "Metadata for the given google.longrunning.Operation.",
@@ -2060,41 +1610,10 @@
},
"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": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There 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"
- }
- }
- },
- "id": "Status"
- },
"IdentityAwareProxy": {
"description": "Identity-Aware Proxy",
"type": "object",
"properties": {
- "enabled": {
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
- "type": "boolean"
- },
"oauth2ClientSecret": {
"description": "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"
@@ -2106,15 +1625,46 @@
"oauth2ClientSecretSha256": {
"description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
"type": "string"
+ },
+ "enabled": {
+ "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
+ "type": "boolean"
}
},
"id": "IdentityAwareProxy"
},
- "TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions.",
+ "Status": {
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There 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"
+ }
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "id": "Status"
+ },
+ "TrafficSplit": {
+ "properties": {
"shardBy": {
+ "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
+ "type": "string",
"enumDescriptions": [
"Diversion method unspecified.",
"Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or else no diversion will occur.",
@@ -2124,9 +1674,7 @@
"UNSPECIFIED",
"COOKIE",
"IP"
- ],
- "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
- "type": "string"
+ ]
},
"allocations": {
"additionalProperties": {
@@ -2137,7 +1685,9 @@
"type": "object"
}
},
- "id": "TrafficSplit"
+ "id": "TrafficSplit",
+ "description": "Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions.",
+ "type": "object"
},
"ManualScaling": {
"description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
@@ -2155,13 +1705,13 @@
"description": "Metadata for the given google.cloud.location.Location.",
"type": "object",
"properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
"standardEnvironmentAvailable": {
"description": "App Engine Standard Environment is available in the given location.@OutputOnly",
"type": "boolean"
+ },
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
}
},
"id": "LocationMetadata"
@@ -2207,8 +1757,6 @@
"type": "object"
},
"ListModulesResponse": {
- "description": "Response message for Modules.ListModules.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
@@ -2222,32 +1770,9 @@
}
}
},
- "id": "ListModulesResponse"
- },
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
- "properties": {
- "container": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
- },
- "sourceReferences": {
- "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
- "type": "array",
- "items": {
- "$ref": "SourceReference"
- }
- },
- "files": {
- "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
- "type": "object",
- "additionalProperties": {
- "$ref": "FileInfo"
- }
- }
- },
- "id": "Deployment"
+ "id": "ListModulesResponse",
+ "description": "Response message for Modules.ListModules.",
+ "type": "object"
},
"Resources": {
"description": "Machine resources for a version.",
@@ -2278,6 +1803,31 @@
},
"id": "Resources"
},
+ "Deployment": {
+ "properties": {
+ "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"
+ }
+ },
+ "container": {
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ },
+ "sourceReferences": {
+ "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
+ "type": "array",
+ "items": {
+ "$ref": "SourceReference"
+ }
+ }
+ },
+ "id": "Deployment",
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object"
+ },
"Volume": {
"description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
"type": "object",
@@ -2320,6 +1870,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/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
"type": "string"
@@ -2337,42 +1895,488 @@
"description": "Timestamp that this operation was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
+ }
+ },
+ "id": "OperationMetadata"
+ },
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
},
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "type": "array",
+ "items": {
+ "$ref": "Instance"
+ }
+ }
+ },
+ "id": "ListInstancesResponse"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object",
+ "properties": {
+ "errorCode": {
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "description": "Error condition this handler applies to.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ]
+ },
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorHandler"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
"target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "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"
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "OperationMetadataV1"
+ },
+ "Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
"type": "string"
}
},
- "id": "OperationMetadata"
+ "id": "Network"
+ },
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object",
+ "properties": {
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ }
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "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"
+ },
+ "location": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Application"
+ },
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a module.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ },
+ "module": {
+ "description": "Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: default.",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule"
+ },
+ "Instance": {
+ "properties": {
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmUnlocked": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/modules/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"
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "availability": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "startTimestamp": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Instance",
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object",
+ "properties": {
+ "versions": {
+ "description": "The versions belonging to the requested module.",
+ "type": "array",
+ "items": {
+ "$ref": "Version"
+ }
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListVersionsResponse"
+ },
+ "Module": {
+ "description": "A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.",
+ "type": "object",
+ "properties": {
+ "split": {
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module.",
+ "$ref": "TrafficSplit"
+ },
+ "id": {
+ "description": "Relative name of the module within the application. Example: default.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Module"
+ },
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "type": "object",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ApiEndpointHandler"
+ },
+ "AutomaticScaling": {
+ "properties": {
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
+ },
+ "diskUtilization": {
+ "description": "Target scaling by disk usage.",
+ "$ref": "DiskUtilization"
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "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 module.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "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"
+ }
+ },
+ "id": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object"
+ },
+ "StaticDirectoryHandler": {
+ "properties": {
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "directory": {
+ "description": "Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "StaticDirectoryHandler",
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.",
+ "type": "object"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object"
+ }
+ },
+ "id": "Location"
+ },
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetReceivedBytesPerSec": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSec": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentBytesPerSec": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSec": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization"
}
},
"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": "v1beta4",
- "baseUrl": "https://appengine.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
- "kind": "discovery#restDescription",
- "servicePath": ""
+ "baseUrl": "https://appengine.googleapis.com/"
}
diff --git a/appengine/v1beta4/appengine-gen.go b/appengine/v1beta4/appengine-gen.go
index 7da7037..57d6a4b 100644
--- a/appengine/v1beta4/appengine-gen.go
+++ b/appengine/v1beta4/appengine-gen.go
@@ -1975,7 +1975,7 @@
// 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
+// error detail types in the package google.rpc that can be used for
// common error conditions.Language mappingThe Status message is the
// logical representation of the error model, but it is not necessarily
// the actual wire format. When the Status message is exposed in
@@ -1990,7 +1990,7 @@
// 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.
+// have a Status message for error reporting.
// 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.
@@ -2364,6 +2364,11 @@
// Runtime: Desired runtime. Example: python27.
Runtime string `json:"runtime,omitempty"`
+ // RuntimeApiVersion: The version of the API in the given runtime
+ // environment. Please see the app.yaml reference for valid values at
+ // https://cloud.google.com/appengine/docs/standard/<language>/config/appref
+ RuntimeApiVersion string `json:"runtimeApiVersion,omitempty"`
+
// ServingStatus: 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
@@ -5643,9 +5648,14 @@
// 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.
+// UNIMPLEMENTED.NOTE: the name binding allows API services to override
+// the binding to use different resource name schemes, such as
+// users/*/operations. To override the binding, API services can add a
+// binding such as "/v1/{name=users/*}/operations" to their service
+// configuration. For backwards compatibility, the default name includes
+// the operations collection id, however overriding users must ensure
+// the name binding is the parent resource, without the operations
+// collection id.
func (r *AppsOperationsService) List(appsId string) *AppsOperationsListCall {
c := &AppsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -5767,7 +5777,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
// "flatPath": "v1beta4/apps/{appsId}/operations",
// "httpMethod": "GET",
// "id": "appengine.apps.operations.list",
@@ -5776,7 +5786,7 @@
// ],
// "parameters": {
// "appsId": {
- // "description": "Part of `name`. The name of the operation collection.",
+ // "description": "Part of `name`. The name of the operation's parent resource.",
// "location": "path",
// "required": true,
// "type": "string"
diff --git a/appengine/v1beta5/appengine-api.json b/appengine/v1beta5/appengine-api.json
index bcf4707..907049d 100644
--- a/appengine/v1beta5/appengine-api.json
+++ b/appengine/v1beta5/appengine-api.json
@@ -7,9 +7,9 @@
"ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
- "id": "appengine:v1beta5",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20170426",
+ "id": "appengine:v1beta5",
+ "revision": "20170525",
"title": "Google App Engine Admin API",
"discoveryVersion": "v1",
"ownerName": "Google",
@@ -17,9 +17,6 @@
"apps": {
"methods": {
"get": {
- "id": "appengine.apps.get",
- "path": "v1beta5/apps/{appsId}",
- "description": "Gets information about an application.",
"httpMethod": "GET",
"parameterOrder": [
"appsId"
@@ -43,133 +40,136 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta5/apps/{appsId}"
+ "flatPath": "v1beta5/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "path": "v1beta5/apps/{appsId}",
+ "description": "Gets information about an application."
},
"patch": {
- "flatPath": "v1beta5/apps/{appsId}",
- "path": "v1beta5/apps/{appsId}",
"id": "appengine.apps.patch",
+ "path": "v1beta5/apps/{appsId}",
"description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)",
"request": {
"$ref": "Application"
},
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"appsId"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "mask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
"appsId": {
"location": "path",
"description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
"required": true,
"type": "string"
+ },
+ "mask": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
}
- }
+ },
+ "flatPath": "v1beta5/apps/{appsId}"
},
"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"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta5/apps",
+ "path": "v1beta5/apps",
"id": "appengine.apps.create",
- "path": "v1beta5/apps"
+ "request": {
+ "$ref": "Application"
+ },
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/)."
}
},
"resources": {
"locations": {
"methods": {
"list": {
+ "description": "Lists information about the supported locations for this service.",
"httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
"response": {
"$ref": "ListLocationsResponse"
},
+ "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": {
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"pageToken": {
"description": "The standard list page token.",
"type": "string",
"location": "query"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
}
},
"flatPath": "v1beta5/apps/{appsId}/locations",
"id": "appengine.apps.locations.list",
- "path": "v1beta5/apps/{appsId}/locations",
- "description": "Lists information about the supported locations for this service."
+ "path": "v1beta5/apps/{appsId}/locations"
},
"get": {
"httpMethod": "GET",
- "response": {
- "$ref": "Location"
- },
"parameterOrder": [
"appsId",
"locationsId"
],
- "parameters": {
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string"
- }
+ "response": {
+ "$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "parameters": {
+ "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": "v1beta5/apps/{appsId}/locations/{locationsId}",
"id": "appengine.apps.locations.get",
"path": "v1beta5/apps/{appsId}/locations/{locationsId}",
@@ -178,211 +178,29 @@
}
},
"services": {
- "methods": {
- "delete": {
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete",
- "description": "Deletes the specified service and all enclosed versions.",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}"
- },
- "get": {
- "description": "Gets the current configuration of the specified service.",
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "servicesId": {
- "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"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get"
- },
- "list": {
- "description": "Lists all the services in the application.",
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services",
- "path": "v1beta5/apps/{appsId}/services",
- "id": "appengine.apps.services.list"
- },
- "patch": {
- "id": "appengine.apps.services.patch",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "description": "Updates the configuration of the specified service.",
- "request": {
- "$ref": "Service"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "migrateTraffic": {
- "location": "query",
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "type": "boolean"
- },
- "mask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}"
- }
- },
"resources": {
"versions": {
"methods": {
- "delete": {
- "id": "appengine.apps.services.versions.delete",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "description": "Deletes an existing version.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "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": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
"get": {
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.get",
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
+ "response": {
+ "$ref": "Version"
+ },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
"httpMethod": "GET",
- "response": {
- "$ref": "Version"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
+ "type": "string"
+ },
"versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -399,41 +217,49 @@
"location": "query"
},
"servicesId": {
+ "location": "path",
"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"
+ "type": "string"
}
},
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta5/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."
- },
- "list": {
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list",
- "description": "Lists the versions of a service.",
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ },
+ "list": {
+ "id": "appengine.apps.services.versions.list",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "description": "Lists the versions of a service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
"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"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
"pageSize": {
"location": "query",
"description": "Maximum results to return per page.",
@@ -441,94 +267,78 @@
"type": "integer"
},
"view": {
- "description": "Controls the set of fields returned in the List 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.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ ],
+ "description": "Controls the set of fields returned in the List response.",
"type": "string",
"location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions"
},
"patch": {
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
"required": true,
"type": "string",
"location": "path"
},
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
"mask": {
+ "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"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"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.patch",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch"
- },
- "create": {
- "description": "Deploys new code and resource files to a new version.",
"request": {
"$ref": "Version"
},
- "httpMethod": "POST",
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment."
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -547,62 +357,57 @@
}
},
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
"id": "appengine.apps.services.versions.create",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions"
+ "description": "Deploys new code and resource files to a new version.",
+ "request": {
+ "$ref": "Version"
+ }
+ },
+ "delete": {
+ "description": "Deletes an existing version.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "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": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete"
}
},
"resources": {
"instances": {
"methods": {
- "debug": {
- "path": "v1beta5/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"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug"
- },
"delete": {
+ "description": "Stops a running instance.",
"httpMethod": "DELETE",
"response": {
"$ref": "Operation"
@@ -613,9 +418,6 @@
"versionsId",
"instancesId"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/services/default/versions/v1/instances/instance-1\".",
@@ -636,16 +438,18 @@
"type": "string"
},
"servicesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
"id": "appengine.apps.services.versions.instances.delete",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Stops a running instance."
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
},
"get": {
"description": "Gets instance information.",
@@ -665,6 +469,12 @@
"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"
+ },
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -682,12 +492,6 @@
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
}
},
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
@@ -695,20 +499,25 @@
"id": "appengine.apps.services.versions.instances.get"
},
"list": {
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
"id": "appengine.apps.services.versions.instances.list",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
"description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
"httpMethod": "GET",
- "response": {
- "$ref": "ListInstancesResponse"
- },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
"parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
"required": true,
@@ -727,28 +536,219 @@
"location": "query"
},
"versionsId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"
+ },
+ "debug": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "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": {
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "Service"
+ },
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.get",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "description": "Gets the current configuration of the specified service."
+ },
+ "list": {
+ "description": "Lists all the services in the application.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
+ "path": "v1beta5/apps/{appsId}/services"
+ },
+ "patch": {
+ "description": "Updates the configuration of the specified service.",
+ "request": {
+ "$ref": "Service"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string"
+ },
+ "migrateTraffic": {
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
+ "type": "boolean",
+ "location": "query"
+ },
+ "mask": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "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"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.delete",
+ "description": "Deletes the specified service and all enclosed versions."
+ }
}
},
"operations": {
@@ -761,62 +761,58 @@
"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": {
- "location": "path",
- "description": "Part of `name`. 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"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1beta5/apps/{appsId}/operations",
"id": "appengine.apps.operations.list",
"path": "v1beta5/apps/{appsId}/operations",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations."
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
},
"get": {
- "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "path": "v1beta5/apps/{appsId}/operations/{operationsId}",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"operationsId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "GET",
"parameters": {
- "appsId": {
+ "operationsId": {
"location": "path",
- "description": "Part of `name`. The name of the operation resource.",
+ "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
},
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
"required": true,
"type": "string",
"location": "path"
@@ -826,7 +822,11 @@
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}",
+ "path": "v1beta5/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
}
}
}
@@ -834,6 +834,53 @@
}
},
"parameters": {
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -851,14 +898,9 @@
"type": "string"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enumDescriptions": [
@@ -873,361 +915,45 @@
"description": "V1 error format.",
"type": "string"
},
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "callback": {
+ "description": "JSONP",
"type": "string",
"location": "query"
}
},
"schemas": {
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "instances": {
- "description": "The instances belonging to the requested version.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
- }
- },
- "id": "ListInstancesResponse"
- },
- "OperationMetadataV1": {
- "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",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "errorCode": {
- "description": "Error condition this handler applies to.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ]
- },
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "defaultHostname": {
- "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "codeBucket": {
- "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "location": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "defaultBucket": {
- "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- }
- },
- "id": "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"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "subnetworkName": {
- "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
- "type": "string"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network"
- },
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "service": {
- "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
- "properties": {
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "vmUnlocked": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "averageLatency": {
- "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"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "availability": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "uint32",
- "type": "integer"
- },
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "startTimestamp": {
- "description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "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"
- }
- },
- "id": "Instance"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "versions": {
- "description": "The versions belonging to the requested service.",
- "type": "array",
- "items": {
- "$ref": "Version"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
"AutomaticScaling": {
"description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
"type": "object",
"properties": {
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "description": "Target scaling by network usage.",
+ "$ref": "NetworkUtilization"
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxPendingLatency": {
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "$ref": "CpuUtilization"
+ },
"diskUtilization": {
"$ref": "DiskUtilization",
"description": "Target scaling by disk usage."
@@ -1237,15 +963,15 @@
"format": "google-duration",
"type": "string"
},
+ "requestUtilization": {
+ "description": "Target scaling by request utilization.",
+ "$ref": "RequestUtilization"
+ },
"maxIdleInstances": {
"description": "Maximum number of idle instances that should be maintained for this version.",
"format": "int32",
"type": "integer"
},
- "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 module.",
"format": "int32",
@@ -1255,42 +981,48 @@
"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": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
}
},
"id": "AutomaticScaling"
},
+ "NetworkUtilization": {
+ "properties": {
+ "targetReceivedBytesPerSec": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSec": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentBytesPerSec": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSec": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization",
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object"
+ },
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
"type": "string"
@@ -1306,46 +1038,33 @@
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
- },
- "labels": {
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
}
},
"id": "Location"
},
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "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": {
- "targetSentBytesPerSec": {
- "description": "Target bytes sent per second.",
- "format": "int32",
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "healthyThreshold": {
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "format": "uint32",
"type": "integer"
},
- "targetReceivedPacketsPerSec": {
- "description": "Target packets received per second.",
- "format": "int32",
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "format": "uint32",
"type": "integer"
},
- "targetReceivedBytesPerSec": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
},
- "targetSentPacketsPerSec": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization"
- },
- "HealthCheck": {
- "properties": {
"timeout": {
"description": "Time before the health check is considered failed.",
"format": "google-duration",
@@ -1359,30 +1078,9 @@
"disableHealthCheck": {
"description": "Whether to explicitly disable health checks for this instance.",
"type": "boolean"
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "restartThreshold": {
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "format": "uint32",
- "type": "integer"
- },
- "healthyThreshold": {
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
}
},
- "id": "HealthCheck",
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "type": "object"
+ "id": "HealthCheck"
},
"SourceReference": {
"description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
@@ -1400,30 +1098,15 @@
"id": "SourceReference"
},
"DebugInstanceRequest": {
- "description": "Request message for Instances.DebugInstance.",
- "type": "object",
"properties": {
"sshKey": {
"description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
"type": "string"
}
},
- "id": "DebugInstanceRequest"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
- "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"
+ "id": "DebugInstanceRequest",
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object"
},
"OperationMetadataV1Beta5": {
"description": "Metadata for the given google.longrunning.Operation.",
@@ -1454,6 +1137,21 @@
},
"id": "OperationMetadataV1Beta5"
},
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ }
+ },
+ "id": "Library"
+ },
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"type": "object",
@@ -1484,17 +1182,38 @@
"id": "ContainerInfo"
},
"Version": {
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
+ "type": "object",
"properties": {
- "network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "$ref": "Network"
+ "basicScaling": {
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "$ref": "BasicScaling"
},
- "betaSettings": {
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
+ "type": "string"
+ },
+ "envVariables": {
+ "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
+ }
+ },
+ "network": {
+ "$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"
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
},
"env": {
"description": "App Engine execution environment to use for this version.Defaults to 1.",
@@ -1553,6 +1272,8 @@
"type": "string"
},
"servingStatus": {
+ "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
+ "type": "string",
"enumDescriptions": [
"Not specified.",
"Currently serving. Instances are created according to the scaling settings of the version.",
@@ -1562,14 +1283,20 @@
"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"
},
+ "runtimeApiVersion": {
+ "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
+ "type": "string"
+ },
+ "resources": {
+ "description": "Machine resources for this version. Only applicable for VM runtimes.",
+ "$ref": "Resources"
+ },
"inboundServices": {
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"type": "array",
@@ -1599,10 +1326,6 @@
"Enables warmup requests."
]
},
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
"errorHandlers": {
"description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
"type": "array",
@@ -1630,30 +1353,9 @@
"description": "Time that this version was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
- },
- "basicScaling": {
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "$ref": "BasicScaling"
- },
- "runtime": {
- "description": "Desired runtime. Example: python27.",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
- "type": "string"
- },
- "envVariables": {
- "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
}
},
- "id": "Version",
- "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
- "type": "object"
+ "id": "Version"
},
"RequestUtilization": {
"properties": {
@@ -1672,18 +1374,25 @@
"description": "Target scaling by request utilization. Only applicable for VM runtimes.",
"type": "object"
},
+ "EndpointsApiService": {
+ "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
+ "type": "object",
+ "properties": {
+ "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": {
- "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.",
@@ -1721,18 +1430,18 @@
]
},
"authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with an401 HTTP status code and an error message."
- ],
"enum": [
"AUTH_FAIL_ACTION_UNSPECIFIED",
"AUTH_FAIL_ACTION_REDIRECT",
"AUTH_FAIL_ACTION_UNAUTHORIZED"
],
"description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with an401 HTTP status code and an error message."
+ ]
},
"script": {
"description": "Executes a script to handle the request that matches this URL pattern.",
@@ -1757,25 +1466,18 @@
],
"description": "Level of login required to access this resource.",
"type": "string"
+ },
+ "apiEndpoint": {
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
+ },
+ "staticFiles": {
+ "description": "Returns the contents of a file, such as an image, as the response.",
+ "$ref": "StaticFilesHandler"
}
},
"id": "UrlMap"
},
- "EndpointsApiService": {
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
- "type": "string"
- }
- },
- "id": "EndpointsApiService"
- },
"ApiConfigHandler": {
"properties": {
"url": {
@@ -1783,8 +1485,6 @@
"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.",
@@ -1798,7 +1498,9 @@
"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.",
@@ -1819,8 +1521,6 @@
"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.",
@@ -1832,7 +1532,9 @@
"LOGIN_OPTIONAL",
"LOGIN_ADMIN",
"LOGIN_REQUIRED"
- ]
+ ],
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "type": "string"
}
},
"id": "ApiConfigHandler",
@@ -1843,18 +1545,6 @@
"description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
"done": {
"description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
"type": "boolean"
@@ -1870,68 +1560,22 @@
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
}
},
"id": "Operation"
},
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
- "type": "string"
- },
- "sourceUrl": {
- "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- },
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
- "type": "string"
- }
- },
- "id": "FileInfo"
- },
- "StaticFilesHandler": {
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Time a static file served by this handler should be cached.",
- "format": "google-duration",
- "type": "string"
- },
- "httpHeaders": {
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
- "type": "string"
- }
- },
- "id": "StaticFilesHandler"
- },
"ScriptHandler": {
"description": "Executes a script to handle the request that matches the URL pattern.",
"type": "object",
@@ -1943,15 +1587,85 @@
},
"id": "ScriptHandler"
},
+ "StaticFilesHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
+ "type": "object",
+ "properties": {
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "httpHeaders": {
+ "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"
+ }
+ },
+ "id": "StaticFilesHandler"
+ },
+ "FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "type": "object",
+ "properties": {
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "id": "FileInfo"
+ },
+ "BasicScaling": {
+ "properties": {
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "idleTimeout": {
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "BasicScaling",
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "type": "object"
+ },
"DiskUtilization": {
"description": "Target scaling by disk usage. Only applicable for VM runtimes.",
"type": "object",
"properties": {
- "targetReadOpsPerSec": {
- "description": "Target ops read per second.",
- "format": "int32",
- "type": "integer"
- },
"targetReadBytesPerSec": {
"description": "Target bytes read per second.",
"format": "int32",
@@ -1966,31 +1680,23 @@
"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": {
- "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.",
+ "targetReadOpsPerSec": {
+ "description": "Target ops read per second.",
"format": "int32",
"type": "integer"
}
},
- "id": "BasicScaling"
+ "id": "DiskUtilization"
},
"OperationMetadataExperimental": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "type": "string"
+ },
"insertTime": {
"description": "Time that this operation was created.@OutputOnly",
"format": "google-datetime",
@@ -2008,15 +1714,13 @@
"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"
}
},
"id": "OperationMetadataExperimental"
},
"CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "type": "object",
"properties": {
"aggregationWindowLength": {
"description": "Period of time over which CPU utilization is calculated.",
@@ -2029,40 +1733,36 @@
"type": "number"
}
},
- "id": "CpuUtilization",
- "description": "Target scaling by CPU usage.",
- "type": "object"
+ "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.",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There 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": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
}
},
"id": "Status"
},
"IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "type": "object",
"properties": {
"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.",
@@ -2081,7 +1781,9 @@
"type": "string"
}
},
- "id": "IdentityAwareProxy"
+ "id": "IdentityAwareProxy",
+ "description": "Identity-Aware Proxy",
+ "type": "object"
},
"ManualScaling": {
"description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
@@ -2143,8 +1845,12 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
@@ -2155,6 +1861,11 @@
"type": "string"
}
},
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
@@ -2166,22 +1877,11 @@
"ephemeralMessage": {
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "OperationMetadataV1Beta"
},
"ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "type": "object",
"properties": {
"services": {
"description": "The services belonging to the requested application.",
@@ -2195,11 +1895,11 @@
"type": "string"
}
},
- "id": "ListServicesResponse"
+ "id": "ListServicesResponse",
+ "description": "Response message for Services.ListServices.",
+ "type": "object"
},
"Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
"properties": {
"volumes": {
"description": "Volumes mounted within the app container.",
@@ -2224,19 +1924,14 @@
"type": "number"
}
},
- "id": "Resources"
+ "id": "Resources",
+ "description": "Machine resources for a version.",
+ "type": "object"
},
"Deployment": {
"description": "Code and application artifacts used to deploy a version to App Engine.",
"type": "object",
"properties": {
- "files": {
- "additionalProperties": {
- "$ref": "FileInfo"
- },
- "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
- "type": "object"
- },
"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."
@@ -2247,11 +1942,40 @@
"items": {
"$ref": "SourceReference"
}
+ },
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
+ "type": "object"
}
},
"id": "Deployment"
},
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "sizeGb": {
+ "description": "Volume size in gigabytes.",
+ "format": "double",
+ "type": "number"
+ },
+ "name": {
+ "description": "Unique name for the volume.",
+ "type": "string"
+ },
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
+ }
+ },
+ "id": "Volume"
+ },
"Service": {
+ "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
+ "type": "object",
"properties": {
"name": {
"description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
@@ -2266,52 +1990,41 @@
"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 other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
- "type": "object"
- },
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
- },
- "sizeGb": {
- "description": "Volume size in gigabytes.",
- "format": "double",
- "type": "number"
- },
- "name": {
- "description": "Unique name for the volume.",
- "type": "string"
- }
- },
- "id": "Volume"
+ "id": "Service"
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Operation"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
"properties": {
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
"type": "string"
@@ -2324,42 +2037,333 @@
"operationType": {
"description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
"type": "string"
+ }
+ },
+ "id": "OperationMetadata",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
},
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "type": "array",
+ "items": {
+ "$ref": "Instance"
+ }
+ }
+ },
+ "id": "ListInstancesResponse"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
},
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
}
},
- "id": "OperationMetadata"
+ "id": "OperationMetadataV1"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object",
+ "properties": {
+ "errorCode": {
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "description": "Error condition this handler applies to.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorHandler"
+ },
+ "Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "subnetworkName": {
+ "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ }
+ },
+ "id": "Network"
+ },
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object",
+ "properties": {
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ }
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "codeBucket": {
+ "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Application"
+ },
+ "UrlDispatchRule": {
+ "properties": {
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ },
+ "service": {
+ "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule",
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "type": "object"
+ },
+ "Instance": {
+ "properties": {
+ "vmUnlocked": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "availability": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "startTimestamp": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "Instance",
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object",
+ "properties": {
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "type": "array",
+ "items": {
+ "$ref": "Version"
+ }
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListVersionsResponse"
+ },
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "type": "object",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ApiEndpointHandler"
}
},
+ "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": "v1beta5",
"baseUrl": "https://appengine.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
}
}
}
diff --git a/appengine/v1beta5/appengine-gen.go b/appengine/v1beta5/appengine-gen.go
index 08e7a15..20816e8 100644
--- a/appengine/v1beta5/appengine-gen.go
+++ b/appengine/v1beta5/appengine-gen.go
@@ -1973,7 +1973,7 @@
// 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
+// error detail types in the package google.rpc that can be used for
// common error conditions.Language mappingThe Status message is the
// logical representation of the error model, but it is not necessarily
// the actual wire format. When the Status message is exposed in
@@ -1988,7 +1988,7 @@
// 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.
+// have a Status message for error reporting.
// 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.
@@ -2367,6 +2367,11 @@
// Runtime: Desired runtime. Example: python27.
Runtime string `json:"runtime,omitempty"`
+ // RuntimeApiVersion: The version of the API in the given runtime
+ // environment. Please see the app.yaml reference for valid values at
+ // https://cloud.google.com/appengine/docs/standard/<language>/config/appref
+ RuntimeApiVersion string `json:"runtimeApiVersion,omitempty"`
+
// ServingStatus: 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
@@ -3416,9 +3421,14 @@
// 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.
+// UNIMPLEMENTED.NOTE: the name binding allows API services to override
+// the binding to use different resource name schemes, such as
+// users/*/operations. To override the binding, API services can add a
+// binding such as "/v1/{name=users/*}/operations" to their service
+// configuration. For backwards compatibility, the default name includes
+// the operations collection id, however overriding users must ensure
+// the name binding is the parent resource, without the operations
+// collection id.
func (r *AppsOperationsService) List(appsId string) *AppsOperationsListCall {
c := &AppsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -3540,7 +3550,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
// "flatPath": "v1beta5/apps/{appsId}/operations",
// "httpMethod": "GET",
// "id": "appengine.apps.operations.list",
@@ -3549,7 +3559,7 @@
// ],
// "parameters": {
// "appsId": {
- // "description": "Part of `name`. The name of the operation collection.",
+ // "description": "Part of `name`. The name of the operation's parent resource.",
// "location": "path",
// "required": true,
// "type": "string"
diff --git a/bigquery/v2/bigquery-api.json b/bigquery/v2/bigquery-api.json
index 67509d3..5e25468 100644
--- a/bigquery/v2/bigquery-api.json
+++ b/bigquery/v2/bigquery-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/4k7_mz3_hjiHB-sQeq0R5OymfdI\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/2rTkbLdOIAhBh7ruqdElb4pGgf8\"",
"discoveryVersion": "v1",
"id": "bigquery:v2",
"name": "bigquery",
"version": "v2",
- "revision": "20170408",
+ "revision": "20170527",
"title": "BigQuery API",
"description": "A data platform for customers to create, manage, share and query data.",
"ownerDomain": "google.com",
@@ -552,7 +552,7 @@
},
"errors": {
"type": "array",
- "description": "[Output-only] All errors and warnings encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.",
+ "description": "[Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.",
"items": {
"$ref": "ErrorProto"
}
@@ -851,7 +851,7 @@
"properties": {
"allowLargeResults": {
"type": "boolean",
- "description": "[Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed.",
+ "description": "[Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.",
"default": "false"
},
"createDisposition": {
@@ -864,7 +864,7 @@
},
"destinationTable": {
"$ref": "TableReference",
- "description": "[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results."
+ "description": "[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size."
},
"flattenResults": {
"type": "boolean",
@@ -896,7 +896,7 @@
},
"query": {
"type": "string",
- "description": "[Required] BigQuery SQL query to execute."
+ "description": "[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL."
},
"queryParameters": {
"type": "array",
@@ -1206,7 +1206,7 @@
},
"errors": {
"type": "array",
- "description": "[Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.",
+ "description": "[Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.",
"items": {
"$ref": "ErrorProto"
}
@@ -1444,7 +1444,7 @@
},
"errors": {
"type": "array",
- "description": "[Output-only] All errors and warnings encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.",
+ "description": "[Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.",
"items": {
"$ref": "ErrorProto"
}
@@ -1733,7 +1733,7 @@
"properties": {
"description": {
"type": "string",
- "description": "[Optional] The field description. The maximum length is 16K characters."
+ "description": "[Optional] The field description. The maximum length is 1,024 characters."
},
"fields": {
"type": "array",
diff --git a/bigquery/v2/bigquery-gen.go b/bigquery/v2/bigquery-gen.go
index a186da1..118f791 100644
--- a/bigquery/v2/bigquery-gen.go
+++ b/bigquery/v2/bigquery-gen.go
@@ -925,9 +925,10 @@
// CacheHit: Whether the query result was fetched from the query cache.
CacheHit bool `json:"cacheHit,omitempty"`
- // Errors: [Output-only] All errors and warnings encountered during the
- // running of the job. Errors here do not necessarily mean that the job
- // has completed or was unsuccessful.
+ // Errors: [Output-only] The first errors or warnings encountered during
+ // the running of the job. The final message includes the number of
+ // errors that caused the process to stop. Errors here do not
+ // necessarily mean that the job has completed or was unsuccessful.
Errors []*ErrorProto `json:"errors,omitempty"`
// Etag: A hash of this response.
@@ -1418,7 +1419,8 @@
// dialect, allows the query to produce arbitrarily large result tables
// at a slight cost in performance. Requires destinationTable to be set.
// For standard SQL queries, this flag is ignored and large results are
- // always allowed.
+ // always allowed. However, you must still set destinationTable when
+ // result size exceeds the allowed maximum response size.
AllowLargeResults bool `json:"allowLargeResults,omitempty"`
// CreateDisposition: [Optional] Specifies whether the job is allowed to
@@ -1436,7 +1438,8 @@
// DestinationTable: [Optional] Describes the table where the query
// results should be stored. If not present, a new table will be created
- // to store the results.
+ // to store the results. This property must be set for large results
+ // that exceed the maximum response size.
DestinationTable *TableReference `json:"destinationTable,omitempty"`
// FlattenResults: [Optional] If true and query uses legacy SQL dialect,
@@ -1474,7 +1477,9 @@
// INTERACTIVE.
Priority string `json:"priority,omitempty"`
- // Query: [Required] BigQuery SQL query to execute.
+ // Query: [Required] SQL query text to execute. The useLegacySql field
+ // can be used to indicate whether the query uses legacy SQL or standard
+ // SQL.
Query string `json:"query,omitempty"`
// QueryParameters: Query parameters for standard SQL queries.
@@ -1931,9 +1936,10 @@
// indicates that the job has completed and was unsuccessful.
ErrorResult *ErrorProto `json:"errorResult,omitempty"`
- // Errors: [Output-only] All errors encountered during the running of
- // the job. Errors here do not necessarily mean that the job has
- // completed or was unsuccessful.
+ // Errors: [Output-only] The first errors encountered during the running
+ // of the job. The final message includes the number of errors that
+ // caused the process to stop. Errors here do not necessarily mean that
+ // the job has completed or was unsuccessful.
Errors []*ErrorProto `json:"errors,omitempty"`
// State: [Output-only] Running state of the job.
@@ -2305,9 +2311,10 @@
// CacheHit: Whether the query result was fetched from the query cache.
CacheHit bool `json:"cacheHit,omitempty"`
- // Errors: [Output-only] All errors and warnings encountered during the
- // running of the job. Errors here do not necessarily mean that the job
- // has completed or was unsuccessful.
+ // Errors: [Output-only] The first errors or warnings encountered during
+ // the running of the job. The final message includes the number of
+ // errors that caused the process to stop. Errors here do not
+ // necessarily mean that the job has completed or was unsuccessful.
Errors []*ErrorProto `json:"errors,omitempty"`
// JobComplete: Whether the query has completed or not. If rows or
@@ -2758,7 +2765,7 @@
type TableFieldSchema struct {
// Description: [Optional] The field description. The maximum length is
- // 16K characters.
+ // 1,024 characters.
Description string `json:"description,omitempty"`
// Fields: [Optional] Describes the nested schema fields if the type
diff --git a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
index ec4540d..8dbc97e 100644
--- a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
+++ b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
@@ -1,4 +1,5 @@
{
+ "rootUrl": "https://bigquerydatatransfer.googleapis.com/",
"ownerDomain": "google.com",
"name": "bigquerydatatransfer",
"batchPath": "batch",
@@ -8,9 +9,6 @@
"projects": {
"methods": {
"isEnabled": {
- "flatPath": "v1/projects/{projectsId}:isEnabled",
- "path": "v1/{+name}:isEnabled",
- "id": "bigquerydatatransfer.projects.isEnabled",
"request": {
"$ref": "IsEnabledRequest"
},
@@ -24,41 +22,44 @@
"httpMethod": "POST",
"parameters": {
"name": {
- "location": "path",
- "description": "The name of the project resource in the form:\n`projects/{project_id}`",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$"
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the project resource in the form:\n`projects/{project_id}`"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}:isEnabled",
+ "path": "v1/{+name}:isEnabled",
+ "id": "bigquerydatatransfer.projects.isEnabled"
},
"setEnabled": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the project resource in the form:\n`projects/{project_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}:setEnabled",
- "id": "bigquerydatatransfer.projects.setEnabled",
- "path": "v1/{+name}:setEnabled",
"request": {
"$ref": "SetEnabledRequest"
},
- "description": "Enables or disables data transfer for a project. This\nmethod requires the additional scope of\n'https://www.googleapis.com/auth/cloudplatformprojects'\nto manage the cloud project permissions."
+ "description": "Enables or disables data transfer for a project. This\nmethod requires the additional scope of\n'https://www.googleapis.com/auth/cloudplatformprojects'\nto manage the cloud project permissions.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the project resource in the form:\n`projects/{project_id}`"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:setEnabled",
+ "path": "v1/{+name}:setEnabled",
+ "id": "bigquerydatatransfer.projects.setEnabled"
}
},
"resources": {
@@ -66,23 +67,23 @@
"methods": {
"get": {
"flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}",
- "path": "v1/{+name}",
"id": "bigquerydatatransfer.projects.dataSources.get",
+ "path": "v1/{+name}",
"description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
- "response": {
- "$ref": "DataSource"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "DataSource"
+ },
"parameters": {
"name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/dataSources/[^/]+$"
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$",
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`"
}
},
"scopes": [
@@ -90,7 +91,6 @@
]
},
"list": {
- "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
"response": {
"$ref": "ListDataSourcesResponse"
},
@@ -98,32 +98,33 @@
"parent"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ],
"parameters": {
- "parent": {
- "location": "path",
- "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
"pageToken": {
+ "type": "string",
"location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string"
+ "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results."
},
"pageSize": {
"location": "query",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"format": "int32",
"type": "integer"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ],
"flatPath": "v1/projects/{projectsId}/dataSources",
"path": "v1/{+parent}/dataSources",
- "id": "bigquerydatatransfer.projects.dataSources.list"
+ "id": "bigquerydatatransfer.projects.dataSources.list",
+ "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering."
},
"checkValidCreds": {
"response": {
@@ -157,96 +158,11 @@
},
"transferConfigs": {
"methods": {
- "patch": {
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "TransferConfig"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
- },
- "authorizationCode": {
- "type": "string",
- "location": "query",
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application."
- },
- "updateMask": {
- "type": "string",
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "id": "bigquerydatatransfer.projects.transferConfigs.patch",
- "path": "v1/{+name}"
- },
- "get": {
- "description": "Returns information about a data transfer config.",
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.get"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "id": "bigquerydatatransfer.projects.transferConfigs.delete",
- "path": "v1/{+name}",
- "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs."
- },
"list": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.list",
+ "path": "v1/{+parent}/transferConfigs",
+ "description": "Returns information about all data transfers in the project.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
@@ -254,14 +170,11 @@
"response": {
"$ref": "ListTransferConfigsResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ],
"parameters": {
"pageToken": {
- "type": "string",
"location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results."
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
},
"pageSize": {
"type": "integer",
@@ -270,23 +183,22 @@
"format": "int32"
},
"parent": {
- "location": "path",
- "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$"
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`."
},
"dataSourceIds": {
- "location": "query",
- "description": "When specified, only configurations of requested data sources are returned.",
"type": "string",
- "repeated": true
+ "repeated": true,
+ "location": "query",
+ "description": "When specified, only configurations of requested data sources are returned."
}
},
- "flatPath": "v1/projects/{projectsId}/transferConfigs",
- "id": "bigquerydatatransfer.projects.transferConfigs.list",
- "path": "v1/{+parent}/transferConfigs",
- "description": "Returns information about all data transfers in the project."
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ]
},
"create": {
"flatPath": "v1/projects/{projectsId}/transferConfigs",
@@ -329,38 +241,130 @@
"parent"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ],
"parameters": {
"parent": {
+ "location": "path",
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
+ "path": "v1/{+parent}:scheduleRuns",
+ "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns",
+ "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
+ "request": {
+ "$ref": "ScheduleTransferRunsRequest"
+ }
+ },
+ "get": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.get",
+ "description": "Returns information about a data transfer config.",
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
"location": "path",
- "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`."
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ]
+ },
+ "patch": {
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run."
+ },
+ "authorizationCode": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application."
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery"
],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
- "path": "v1/{+parent}:scheduleRuns",
- "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns",
- "request": {
- "$ref": "ScheduleTransferRunsRequest"
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.patch",
+ "path": "v1/{+name}"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
},
- "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range."
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.delete",
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs."
}
},
"resources": {
"runs": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
+ "get": {
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
- "$ref": "Empty"
+ "$ref": "TransferRun"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ],
"parameters": {
"name": {
"location": "path",
@@ -370,38 +374,10 @@
"pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
"path": "v1/{+name}",
- "description": "Deletes the specified transfer run."
- },
- "get": {
- "description": "Returns information about the particular transfer run.",
- "response": {
- "$ref": "TransferRun"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.get"
+ "description": "Returns information about the particular transfer run."
},
"list": {
"response": {
@@ -411,10 +387,33 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ],
"parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
+ },
+ "statuses": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "TRANSFER_STATUS_UNSPECIFIED",
+ "INACTIVE",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "When specified, only transfer runs with requested statuses are returned."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer"
+ },
"runAttempt": {
"location": "query",
"enum": [
@@ -430,66 +429,55 @@
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
"location": "path",
"description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results."
- },
- "statuses": {
- "location": "query",
- "enum": [
- "TRANSFER_STATUS_UNSPECIFIED",
- "INACTIVE",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ],
- "description": "When specified, only transfer runs with requested statuses are returned.",
- "type": "string",
- "repeated": true
- },
- "pageSize": {
- "location": "query",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
"path": "v1/{+parent}/runs",
"id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
"description": "Returns information about running and completed jobs."
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
+ "description": "Deletes the specified transfer run.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ]
}
},
"resources": {
"transferLogs": {
"methods": {
"list": {
- "response": {
- "$ref": "ListTransferLogsResponse"
- },
+ "description": "Returns user facing log messages for the data transfer run.",
+ "httpMethod": "GET",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ],
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer"
- },
"messageTypes": {
"type": "string",
"repeated": true,
@@ -503,17 +491,30 @@
"description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned."
},
"parent": {
+ "location": "path",
+ "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path",
- "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`."
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
- "path": "v1/{+parent}/transferLogs",
"id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
- "description": "Returns user facing log messages for the data transfer run."
+ "path": "v1/{+parent}/transferLogs"
}
}
}
@@ -525,37 +526,32 @@
}
},
"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": {
"type": "boolean",
"default": "true",
"location": "query",
"description": "Pretty-print response."
},
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
"bearer_token": {
"type": "string",
"location": "query",
"description": "OAuth bearer token."
},
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
- "type": "boolean",
- "default": "true",
"location": "query",
- "description": "Returns response with indentations and line breaks."
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
},
"uploadType": {
"location": "query",
@@ -567,6 +563,11 @@
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
},
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
"$.xgafv": {
"type": "string",
"enumDescriptions": [
@@ -580,11 +581,6 @@
],
"description": "V1 error format."
},
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
"alt": {
"type": "string",
"enumDescriptions": [
@@ -601,250 +597,40 @@
"proto"
]
},
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
- "key": {
- "type": "string",
+ "quotaUser": {
"location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
}
},
"version": "v1",
"baseUrl": "https://bigquerydatatransfer.googleapis.com/",
- "servicePath": "",
"kind": "discovery#restDescription",
- "description": "",
+ "servicePath": "",
+ "description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
"basePath": "",
- "revision": "20170423",
- "id": "bigquerydatatransfer:v1",
+ "revision": "20170522",
"documentationLink": "https://cloud.google.com/bigquery/",
+ "id": "bigquerydatatransfer:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "CheckValidCredsResponse": {
- "type": "object",
- "properties": {
- "hasValidCreds": {
- "type": "boolean",
- "description": "If set to `true`, the credentials exist and are valid."
- }
- },
- "id": "CheckValidCredsResponse",
- "description": "A response indicating whether the credentials exist and are valid."
- },
- "ScheduleTransferRunsResponse": {
- "type": "object",
- "properties": {
- "createdRuns": {
- "description": "The transfer runs that were created.",
- "type": "array",
- "items": {
- "$ref": "TransferRun"
- }
- }
- },
- "id": "ScheduleTransferRunsResponse",
- "description": "A response to schedule transfer runs for a time range."
- },
- "ListTransferLogsResponse": {
- "type": "object",
- "properties": {
- "transferMessages": {
- "type": "array",
- "items": {
- "$ref": "TransferMessage"
- },
- "description": "The stored pipeline transfer messages.\n@OutputOnly"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.\n@OutputOnly"
- }
- },
- "id": "ListTransferLogsResponse",
- "description": "The returned list transfer run messages."
- },
- "TransferMessage": {
- "description": "Represents a user facing message for a particular data transfer run.",
- "type": "object",
- "properties": {
- "messageTime": {
- "type": "string",
- "description": "Time when message was logged.",
- "format": "google-datetime"
- },
- "severity": {
- "enum": [
- "MESSAGE_SEVERITY_UNSPECIFIED",
- "INFO",
- "WARNING",
- "ERROR"
- ],
- "description": "Message severity.",
- "type": "string",
- "enumDescriptions": [
- "No severity specified.",
- "Informational message.",
- "Warning message.",
- "Error message."
- ]
- },
- "messageText": {
- "description": "Message text.",
- "type": "string"
- }
- },
- "id": "TransferMessage"
- },
- "ListDataSourcesResponse": {
- "description": "Returns list of supported data sources and their metadata.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
- "type": "string"
- },
- "dataSources": {
- "description": "List of supported data sources and their transfer settings.",
- "type": "array",
- "items": {
- "$ref": "DataSource"
- }
- }
- },
- "id": "ListDataSourcesResponse"
- },
- "DataSourceParameter": {
- "type": "object",
- "properties": {
- "description": {
- "description": "Parameter description.",
- "type": "string"
- },
- "allowedValues": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "All possible values for the parameter."
- },
- "minValue": {
- "type": "number",
- "description": "For integer and double values specifies minimum allowed value.",
- "format": "double"
- },
- "validationHelpUrl": {
- "description": "URL to a help document to further explain the naming requirements.",
- "type": "string"
- },
- "validationRegex": {
- "type": "string",
- "description": "Regular expression which can be used for parameter validation."
- },
- "paramId": {
- "type": "string",
- "description": "Parameter identifier."
- },
- "required": {
- "description": "Is parameter required.",
- "type": "boolean"
- },
- "repeated": {
- "type": "boolean",
- "description": "Can parameter have multiple values."
- },
- "displayName": {
- "description": "Parameter display name in the user interface.",
- "type": "string"
- },
- "immutable": {
- "type": "boolean",
- "description": "Cannot be changed after initial creation."
- },
- "validationDescription": {
- "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.",
- "type": "string"
- },
- "fields": {
- "type": "array",
- "items": {
- "$ref": "DataSourceParameter"
- },
- "description": "When parameter is a record, describes child fields."
- },
- "maxValue": {
- "type": "number",
- "description": "For integer and double values specifies maxminum allowed value.",
- "format": "double"
- },
- "type": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "STRING",
- "INTEGER",
- "DOUBLE",
- "BOOLEAN",
- "RECORD",
- "PLUS_PAGE"
- ],
- "description": "Parameter type.",
- "type": "string",
- "enumDescriptions": [
- "Type unspecified.",
- "String parameter.",
- "Integer parameter (64-bits).\nWill be serialized to json as string.",
- "Double precision floating point parameter.",
- "Boolean parameter.",
- "Record parameter.",
- "Page ID for a Google+ Page."
- ]
- },
- "recurse": {
- "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD.",
- "type": "boolean"
- }
- },
- "id": "DataSourceParameter",
- "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms."
- },
- "ListTransferRunsResponse": {
- "type": "object",
- "properties": {
- "transferRuns": {
- "description": "The stored pipeline transfer runs.\n@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "TransferRun"
- }
- },
- "nextPageToken": {
- "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
- "type": "string"
- }
- },
- "id": "ListTransferRunsResponse",
- "description": "The returned list of pipelines in the project."
- },
"IsEnabledRequest": {
"description": "A request to determine whether data transfer is enabled for the project.",
"type": "object",
"properties": {},
"id": "IsEnabledRequest"
},
- "SetEnabledRequest": {
- "description": "A request to set whether data transfer is enabled or disabled for a project.",
- "type": "object",
- "properties": {
- "enabled": {
- "description": "Whether data transfer should be enabled or disabled for the project.",
- "type": "boolean"
- }
- },
- "id": "SetEnabledRequest"
- },
"ListTransferConfigsResponse": {
"type": "object",
"properties": {
@@ -856,13 +642,24 @@
"description": "The stored pipeline transfer configurations.\n@OutputOnly"
},
"nextPageToken": {
- "type": "string",
- "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.\n@OutputOnly"
+ "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
+ "type": "string"
}
},
"id": "ListTransferConfigsResponse",
"description": "The returned list of pipelines in the project."
},
+ "SetEnabledRequest": {
+ "description": "A request to set whether data transfer is enabled or disabled for a project.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Whether data transfer should be enabled or disabled for the project.",
+ "type": "boolean"
+ }
+ },
+ "id": "SetEnabledRequest"
+ },
"IsEnabledResponse": {
"description": "A response to indicate whether data transfer is enabled for the project.",
"type": "object",
@@ -877,24 +674,6 @@
"DataSource": {
"type": "object",
"properties": {
- "clientId": {
- "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
- "type": "string"
- },
- "authorizationType": {
- "type": "string",
- "enumDescriptions": [
- "Type unspecified.",
- "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
- "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
- ],
- "enum": [
- "AUTHORIZATION_TYPE_UNSPECIFIED",
- "AUTHORIZATION_CODE",
- "GOOGLE_PLUS_AUTHORIZATION_CODE"
- ],
- "description": "Indicates the type of authorization."
- },
"supportsCustomSchedule": {
"description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule.",
"type": "boolean"
@@ -904,33 +683,33 @@
"type": "string"
},
"dataRefreshType": {
- "enum": [
- "NONE",
- "SLIDING_WINDOW",
- "CUSTOM_SLIDING_WINDOW"
- ],
- "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
"type": "string",
"enumDescriptions": [
"The data source won't support data auto refresh, which is default value.",
"The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.",
"The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
- ]
+ ],
+ "enum": [
+ "NONE",
+ "SLIDING_WINDOW",
+ "CUSTOM_SLIDING_WINDOW"
+ ],
+ "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically."
},
"parameters": {
+ "description": "Data source parameters.",
"type": "array",
"items": {
"$ref": "DataSourceParameter"
- },
- "description": "Data source parameters."
+ }
},
"helpUrl": {
"type": "string",
"description": "Url for the help document for this data source."
},
"defaultSchedule": {
- "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
- "type": "string"
+ "type": "string",
+ "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`."
},
"statusUpdateDeadlineSeconds": {
"type": "integer",
@@ -938,50 +717,68 @@
"format": "int32"
},
"supportsMultipleTransfers": {
- "description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets.",
- "type": "boolean"
- },
- "manualRunsDisabled": {
- "description": "Disables backfilling and manual run scheduling\nfor the data source.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets."
},
"defaultDataRefreshWindowDays": {
"description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
"format": "int32",
"type": "integer"
},
+ "manualRunsDisabled": {
+ "description": "Disables backfilling and manual run scheduling\nfor the data source.",
+ "type": "boolean"
+ },
"transferType": {
- "enum": [
- "TRANSFER_TYPE_UNSPECIFIED",
- "BATCH",
- "STREAMING"
- ],
- "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.",
"type": "string",
"enumDescriptions": [
"Invalid or Unknown transfer type placeholder.",
"Batch data transfer.",
"Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project."
- ]
+ ],
+ "enum": [
+ "TRANSFER_TYPE_UNSPECIFIED",
+ "BATCH",
+ "STREAMING"
+ ],
+ "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data."
},
"description": {
- "type": "string",
- "description": "User friendly data source description string."
+ "description": "User friendly data source description string.",
+ "type": "string"
},
"dataSourceId": {
"type": "string",
"description": "Data source id."
},
+ "name": {
+ "description": "Data source resource name.",
+ "type": "string"
+ },
"scopes": {
+ "description": "Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
"type": "array",
"items": {
"type": "string"
- },
- "description": "Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery"
+ }
},
- "name": {
+ "clientId": {
"type": "string",
- "description": "Data source resource name."
+ "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer."
+ },
+ "authorizationType": {
+ "enum": [
+ "AUTHORIZATION_TYPE_UNSPECIFIED",
+ "AUTHORIZATION_CODE",
+ "GOOGLE_PLUS_AUTHORIZATION_CODE"
+ ],
+ "description": "Indicates the type of authorization.",
+ "type": "string",
+ "enumDescriptions": [
+ "Type unspecified.",
+ "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
+ "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
+ ]
}
},
"id": "DataSource",
@@ -1013,6 +810,37 @@
"TransferConfig": {
"type": "object",
"properties": {
+ "displayName": {
+ "type": "string",
+ "description": "User specified display name for the data transfer."
+ },
+ "disabled": {
+ "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
+ "type": "boolean"
+ },
+ "nextRunTime": {
+ "description": "Next time when data transfer will run. Output only. Applicable\nonly for batch data transfers.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "schedule": {
+ "description": "Data transfer schedule in GROC format.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid GROC include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Data transfer modification time. Ignored by server on input.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "dataRefreshWindowDays": {
+ "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dataSourceId": {
+ "type": "string",
+ "description": "Data source id. Cannot be changed once data transfer is created."
+ },
"status": {
"type": "string",
"enumDescriptions": [
@@ -1035,14 +863,14 @@
],
"description": "Status of the most recently updated transfer run.\n@OutputOnly"
},
- "destinationDatasetId": {
- "type": "string",
- "description": "The BigQuery target dataset id."
- },
"name": {
"type": "string",
"description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run."
},
+ "destinationDatasetId": {
+ "type": "string",
+ "description": "The BigQuery target dataset id."
+ },
"userId": {
"description": "GaiaID of the user on whose behalf transfer is done. Applicable only\nto data sources that do not support service accounts. When set to 0,\nthe data source service account credentials are used.\n@OutputOnly",
"format": "int64",
@@ -1055,37 +883,6 @@
},
"description": "Data transfer specific parameters.",
"type": "object"
- },
- "displayName": {
- "type": "string",
- "description": "User specified display name for the data transfer."
- },
- "nextRunTime": {
- "description": "Next time when data transfer will run. Output only. Applicable\nonly for batch data transfers.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "disabled": {
- "type": "boolean",
- "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer."
- },
- "schedule": {
- "type": "string",
- "description": "Data transfer schedule in GROC format.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid GROC include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`."
- },
- "updateTime": {
- "description": "Data transfer modification time. Ignored by server on input.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "dataRefreshWindowDays": {
- "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
- "format": "int32",
- "type": "integer"
- },
- "dataSourceId": {
- "description": "Data source id. Cannot be changed once data transfer is created.",
- "type": "string"
}
},
"id": "TransferConfig",
@@ -1094,35 +891,25 @@
"TransferRun": {
"type": "object",
"properties": {
- "updateTime": {
- "type": "string",
- "description": "Last time the data transfer run status was updated.\n@OutputOnly",
- "format": "google-datetime"
- },
"schedule": {
- "description": "Describes the schedule of this transfer run if it was created as part of\na regular schedule. For batch transfer runs that are directly created,\nthis is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.\n@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "Describes the schedule of this transfer run if it was created as part of\na regular schedule. For batch transfer runs that are directly created,\nthis is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.\n@OutputOnly"
},
- "runTime": {
- "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
+ "updateTime": {
+ "description": "Last time the data transfer run status was updated.\n@OutputOnly",
"format": "google-datetime",
"type": "string"
},
+ "runTime": {
+ "type": "string",
+ "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
+ "format": "google-datetime"
+ },
"dataSourceId": {
- "description": "Data source id.\n@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "Data source id.\n@OutputOnly"
},
"status": {
- "enum": [
- "TRANSFER_STATUS_UNSPECIFIED",
- "INACTIVE",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ],
- "description": "Data transfer run status. Ignored for input requests.\n@OutputOnly",
"type": "string",
"enumDescriptions": [
"Status placeholder.",
@@ -1132,11 +919,17 @@
"Data transfer completed successsfully.",
"Data transfer failed.",
"Data transfer is cancelled."
- ]
- },
- "destinationDatasetId": {
- "description": "The BigQuery target dataset id.",
- "type": "string"
+ ],
+ "enum": [
+ "TRANSFER_STATUS_UNSPECIFIED",
+ "INACTIVE",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "Data transfer run status. Ignored for input requests.\n@OutputOnly"
},
"userId": {
"description": "The user id for this transfer run.\n@OutputOnly",
@@ -1144,16 +937,20 @@
"type": "string"
},
"name": {
- "type": "string",
- "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run."
+ "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
+ "type": "string"
+ },
+ "destinationDatasetId": {
+ "description": "The BigQuery target dataset id.",
+ "type": "string"
},
"params": {
+ "type": "object",
"additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
+ "type": "any",
+ "description": "Properties of the object."
},
- "description": "Data transfer specific parameters.",
- "type": "object"
+ "description": "Data transfer specific parameters."
},
"endTime": {
"description": "Time when transfer run ended. Parameter ignored by server for input\nrequests.\n@OutputOnly",
@@ -1161,14 +958,14 @@
"type": "string"
},
"startTime": {
- "type": "string",
"description": "Time when transfer run was started. Parameter ignored by server for input\nrequests.\n@OutputOnly",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"scheduleTime": {
- "type": "string",
"description": "Minimum time after which a transfer run can be started.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "TransferRun",
@@ -1179,13 +976,217 @@
"type": "object",
"properties": {},
"id": "CheckValidCredsRequest"
+ },
+ "CheckValidCredsResponse": {
+ "description": "A response indicating whether the credentials exist and are valid.",
+ "type": "object",
+ "properties": {
+ "hasValidCreds": {
+ "description": "If set to `true`, the credentials exist and are valid.",
+ "type": "boolean"
+ }
+ },
+ "id": "CheckValidCredsResponse"
+ },
+ "ScheduleTransferRunsResponse": {
+ "type": "object",
+ "properties": {
+ "createdRuns": {
+ "description": "The transfer runs that were created.",
+ "type": "array",
+ "items": {
+ "$ref": "TransferRun"
+ }
+ }
+ },
+ "id": "ScheduleTransferRunsResponse",
+ "description": "A response to schedule transfer runs for a time range."
+ },
+ "ListTransferLogsResponse": {
+ "description": "The returned list transfer run messages.",
+ "type": "object",
+ "properties": {
+ "transferMessages": {
+ "type": "array",
+ "items": {
+ "$ref": "TransferMessage"
+ },
+ "description": "The stored pipeline transfer messages.\n@OutputOnly"
+ },
+ "nextPageToken": {
+ "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "ListTransferLogsResponse"
+ },
+ "TransferMessage": {
+ "description": "Represents a user facing message for a particular data transfer run.",
+ "type": "object",
+ "properties": {
+ "messageTime": {
+ "type": "string",
+ "description": "Time when message was logged.",
+ "format": "google-datetime"
+ },
+ "severity": {
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "Message severity.",
+ "type": "string",
+ "enumDescriptions": [
+ "No severity specified.",
+ "Informational message.",
+ "Warning message.",
+ "Error message."
+ ]
+ },
+ "messageText": {
+ "type": "string",
+ "description": "Message text."
+ }
+ },
+ "id": "TransferMessage"
+ },
+ "ListDataSourcesResponse": {
+ "description": "Returns list of supported data sources and their metadata.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_token`\nto request the next page of list results.\n@OutputOnly"
+ },
+ "dataSources": {
+ "description": "List of supported data sources and their transfer settings.",
+ "type": "array",
+ "items": {
+ "$ref": "DataSource"
+ }
+ }
+ },
+ "id": "ListDataSourcesResponse"
+ },
+ "DataSourceParameter": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "DataSourceParameter"
+ },
+ "description": "When parameter is a record, describes child fields."
+ },
+ "maxValue": {
+ "description": "For integer and double values specifies maxminum allowed value.",
+ "format": "double",
+ "type": "number"
+ },
+ "type": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "STRING",
+ "INTEGER",
+ "DOUBLE",
+ "BOOLEAN",
+ "RECORD",
+ "PLUS_PAGE"
+ ],
+ "description": "Parameter type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Type unspecified.",
+ "String parameter.",
+ "Integer parameter (64-bits).\nWill be serialized to json as string.",
+ "Double precision floating point parameter.",
+ "Boolean parameter.",
+ "Record parameter.",
+ "Page ID for a Google+ Page."
+ ]
+ },
+ "recurse": {
+ "type": "boolean",
+ "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD."
+ },
+ "description": {
+ "description": "Parameter description.",
+ "type": "string"
+ },
+ "allowedValues": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "All possible values for the parameter."
+ },
+ "minValue": {
+ "description": "For integer and double values specifies minimum allowed value.",
+ "format": "double",
+ "type": "number"
+ },
+ "validationHelpUrl": {
+ "type": "string",
+ "description": "URL to a help document to further explain the naming requirements."
+ },
+ "validationRegex": {
+ "description": "Regular expression which can be used for parameter validation.",
+ "type": "string"
+ },
+ "paramId": {
+ "description": "Parameter identifier.",
+ "type": "string"
+ },
+ "required": {
+ "description": "Is parameter required.",
+ "type": "boolean"
+ },
+ "repeated": {
+ "description": "Can parameter have multiple values.",
+ "type": "boolean"
+ },
+ "displayName": {
+ "type": "string",
+ "description": "Parameter display name in the user interface."
+ },
+ "immutable": {
+ "type": "boolean",
+ "description": "Cannot be changed after initial creation."
+ },
+ "validationDescription": {
+ "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.",
+ "type": "string"
+ }
+ },
+ "id": "DataSourceParameter",
+ "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms."
+ },
+ "ListTransferRunsResponse": {
+ "description": "The returned list of pipelines in the project.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
+ "type": "string"
+ },
+ "transferRuns": {
+ "type": "array",
+ "items": {
+ "$ref": "TransferRun"
+ },
+ "description": "The stored pipeline transfer runs.\n@OutputOnly"
+ }
+ },
+ "id": "ListTransferRunsResponse"
}
},
- "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": "BIGQUERYDATATRANSFER",
"auth": {
"oauth2": {
@@ -1195,6 +1196,5 @@
}
}
}
- },
- "rootUrl": "https://bigquerydatatransfer.googleapis.com/"
+ }
}
diff --git a/calendar/v3/calendar-api.json b/calendar/v3/calendar-api.json
index 1b2dd59..f6b097c 100644
--- a/calendar/v3/calendar-api.json
+++ b/calendar/v3/calendar-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/vYgKdX3g1VPmww06h2PorJos8j4\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/euj94Rd_zZNye-Ex23VYZId4hug\"",
"discoveryVersion": "v1",
"id": "calendar:v3",
"name": "calendar",
"version": "v3",
- "revision": "20170319",
+ "revision": "20170528",
"title": "Calendar API",
"description": "Manipulates events and other calendar data.",
"ownerDomain": "google.com",
@@ -2232,7 +2232,7 @@
},
"maxResults": {
"type": "integer",
- "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
+ "description": "Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
"default": "250",
"format": "int32",
"minimum": "1",
@@ -2547,7 +2547,7 @@
},
"maxResults": {
"type": "integer",
- "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
+ "description": "Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
"default": "250",
"format": "int32",
"minimum": "1",
diff --git a/calendar/v3/calendar-gen.go b/calendar/v3/calendar-gen.go
index e4557f6..552a798 100644
--- a/calendar/v3/calendar-gen.go
+++ b/calendar/v3/calendar-gen.go
@@ -6157,8 +6157,12 @@
}
// MaxResults sets the optional parameter "maxResults": Maximum number
-// of events returned on one result page. By default the value is 250
-// events. The page size can never be larger than 2500 events.
+// of events returned on one result page. The number of events in the
+// resulting page may be less than this value, or none at all, even if
+// there are more events matching the query. Incomplete pages can be
+// detected by a non-empty nextPageToken field in the response. By
+// default the value is 250 events. The page size can never be larger
+// than 2500 events.
func (c *EventsListCall) MaxResults(maxResults int64) *EventsListCall {
c.urlParams_.Set("maxResults", fmt.Sprint(maxResults))
return c
@@ -6434,7 +6438,7 @@
// },
// "maxResults": {
// "default": "250",
- // "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
+ // "description": "Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
// "format": "int32",
// "location": "query",
// "minimum": "1",
@@ -7304,8 +7308,12 @@
}
// MaxResults sets the optional parameter "maxResults": Maximum number
-// of events returned on one result page. By default the value is 250
-// events. The page size can never be larger than 2500 events.
+// of events returned on one result page. The number of events in the
+// resulting page may be less than this value, or none at all, even if
+// there are more events matching the query. Incomplete pages can be
+// detected by a non-empty nextPageToken field in the response. By
+// default the value is 250 events. The page size can never be larger
+// than 2500 events.
func (c *EventsWatchCall) MaxResults(maxResults int64) *EventsWatchCall {
c.urlParams_.Set("maxResults", fmt.Sprint(maxResults))
return c
@@ -7573,7 +7581,7 @@
// },
// "maxResults": {
// "default": "250",
- // "description": "Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
+ // "description": "Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
// "format": "int32",
// "location": "query",
// "minimum": "1",
diff --git a/classroom/v1/classroom-api.json b/classroom/v1/classroom-api.json
index a65341e..83d16c8 100644
--- a/classroom/v1/classroom-api.json
+++ b/classroom/v1/classroom-api.json
@@ -1,1104 +1,167 @@
{
- "id": "classroom:v1",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/classroom.rosters.readonly": {
- "description": "View your Google Classroom class rosters"
- },
- "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": {
- "description": "View your course work and grades in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly": {
- "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
- },
- "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
- "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
- },
- "https://www.googleapis.com/auth/classroom.rosters": {
- "description": "Manage your Google Classroom class rosters"
- },
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
- "description": "View your course work and grades in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.courses.readonly": {
- "description": "View your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.courses": {
- "description": "Manage your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.coursework.me": {
- "description": "Manage your course work and view your grades in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.coursework.students": {
- "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer"
- },
- "https://www.googleapis.com/auth/classroom.profile.photos": {
- "description": "View the profile photos of people in your classes"
- },
- "https://www.googleapis.com/auth/classroom.profile.emails": {
- "description": "View the email addresses of people in your classes"
- }
- }
- }
- },
- "description": "Manages classes, rosters, and invitations in Google Classroom.",
- "protocol": "rest",
"title": "Google Classroom API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"invitations": {
"methods": {
- "create": {
- "id": "classroom.invitations.create",
- "response": {
- "$ref": "Invitation"
- },
- "parameterOrder": [],
- "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
- "request": {
- "$ref": "Invitation"
- },
- "flatPath": "v1/invitations",
- "httpMethod": "POST",
- "parameters": {},
- "path": "v1/invitations",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
"get": {
- "id": "classroom.invitations.get",
- "response": {
- "$ref": "Invitation"
- },
- "parameterOrder": [
- "id"
- ],
- "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
- "flatPath": "v1/invitations/{id}",
- "httpMethod": "GET",
- "parameters": {
- "id": {
- "description": "Identifier of the invitation to return.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/invitations/{id}",
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
+ ],
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the invitation to return.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/invitations/{id}",
+ "id": "classroom.invitations.get",
+ "path": "v1/invitations/{id}",
+ "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Invitation"
+ }
},
"list": {
- "id": "classroom.invitations.list",
+ "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListInvitationsResponse"
},
"parameterOrder": [],
- "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.",
- "flatPath": "v1/invitations",
- "httpMethod": "GET",
"parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer"
+ },
"courseId": {
"description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "location": "query",
- "type": "integer",
- "format": "int32"
+ "type": "string",
+ "location": "query"
},
"userId": {
- "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"location": "query",
+ "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"type": "string"
},
"pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
"location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
"type": "string"
}
},
- "path": "v1/invitations",
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
+ ],
+ "flatPath": "v1/invitations",
+ "id": "classroom.invitations.list",
+ "path": "v1/invitations"
+ },
+ "create": {
+ "response": {
+ "$ref": "Invitation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {},
+ "flatPath": "v1/invitations",
+ "path": "v1/invitations",
+ "id": "classroom.invitations.create",
+ "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
+ "request": {
+ "$ref": "Invitation"
+ }
+ },
+ "accept": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "id": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the invitation to accept."
+ }
+ },
+ "flatPath": "v1/invitations/{id}:accept",
+ "id": "classroom.invitations.accept",
+ "path": "v1/invitations/{id}:accept",
+ "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID."
},
"delete": {
- "id": "classroom.invitations.delete",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"id"
],
- "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
- "flatPath": "v1/invitations/{id}",
- "httpMethod": "DELETE",
"parameters": {
"id": {
"description": "Identifier of the invitation to delete.",
"required": true,
- "location": "path",
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "path": "v1/invitations/{id}",
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "accept": {
- "id": "classroom.invitations.accept",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
],
- "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID.",
- "flatPath": "v1/invitations/{id}:accept",
- "httpMethod": "POST",
- "parameters": {
- "id": {
- "description": "Identifier of the invitation to accept.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/invitations/{id}:accept",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
+ "flatPath": "v1/invitations/{id}",
+ "id": "classroom.invitations.delete",
+ "path": "v1/invitations/{id}",
+ "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID."
}
}
},
"courses": {
- "resources": {
- "teachers": {
- "methods": {
- "create": {
- "id": "classroom.courses.teachers.create",
- "response": {
- "$ref": "Teacher"
- },
- "parameterOrder": [
- "courseId"
- ],
- "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
- "request": {
- "$ref": "Teacher"
- },
- "flatPath": "v1/courses/{courseId}/teachers",
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/teachers",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "get": {
- "id": "classroom.courses.teachers.get",
- "response": {
- "$ref": "Teacher"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "userId": {
- "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- },
- "list": {
- "id": "classroom.courses.teachers.list",
- "response": {
- "$ref": "ListTeachersResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
- "flatPath": "v1/courses/{courseId}/teachers",
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/teachers",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- },
- "delete": {
- "id": "classroom.courses.teachers.delete",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "httpMethod": "DELETE",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "userId": {
- "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- }
- }
- },
- "aliases": {
- "methods": {
- "create": {
- "id": "classroom.courses.aliases.create",
- "response": {
- "$ref": "CourseAlias"
- },
- "parameterOrder": [
- "courseId"
- ],
- "description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to access a domain-scoped alias).",
- "request": {
- "$ref": "CourseAlias"
- },
- "flatPath": "v1/courses/{courseId}/aliases",
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/aliases",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
- },
- "list": {
- "id": "classroom.courses.aliases.list",
- "response": {
- "$ref": "ListCourseAliasesResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.",
- "flatPath": "v1/courses/{courseId}/aliases",
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/aliases",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ]
- },
- "delete": {
- "id": "classroom.courses.aliases.delete",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "alias"
- ],
- "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).",
- "flatPath": "v1/courses/{courseId}/aliases/{alias}",
- "httpMethod": "DELETE",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "alias": {
- "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/aliases/{alias}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
- }
- }
- },
- "students": {
- "methods": {
- "create": {
- "id": "classroom.courses.students.create",
- "response": {
- "$ref": "Student"
- },
- "parameterOrder": [
- "courseId"
- ],
- "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.",
- "request": {
- "$ref": "Student"
- },
- "flatPath": "v1/courses/{courseId}/students",
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "enrollmentCode": {
- "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/students",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "get": {
- "id": "classroom.courses.students.get",
- "response": {
- "$ref": "Student"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "description": "Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
- "flatPath": "v1/courses/{courseId}/students/{userId}",
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "userId": {
- "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/students/{userId}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- },
- "list": {
- "id": "classroom.courses.students.list",
- "response": {
- "$ref": "ListStudentsResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "description": "Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
- "flatPath": "v1/courses/{courseId}/students",
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/students",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- },
- "delete": {
- "id": "classroom.courses.students.delete",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
- "flatPath": "v1/courses/{courseId}/students/{userId}",
- "httpMethod": "DELETE",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "userId": {
- "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/students/{userId}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- }
- }
- },
- "courseWork": {
- "resources": {
- "studentSubmissions": {
- "methods": {
- "modifyAttachments": {
- "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "ModifyAttachmentsRequest"
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the student submission.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ]
- },
- "reclaim": {
- "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "ReclaimStudentSubmissionRequest"
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the student submission.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me"
- ]
- },
- "turnIn": {
- "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "TurnInStudentSubmissionRequest"
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the student submission.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me"
- ]
- },
- "list": {
- "id": "classroom.courses.courseWork.studentSubmissions.list",
- "response": {
- "$ref": "ListStudentSubmissionsResponse"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId"
- ],
- "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "httpMethod": "GET",
- "parameters": {
- "states": {
- "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
- "enum": [
- "SUBMISSION_STATE_UNSPECIFIED",
- "NEW",
- "CREATED",
- "TURNED_IN",
- "RETURNED",
- "RECLAIMED_BY_STUDENT"
- ],
- "repeated": true,
- "location": "query",
- "type": "string"
- },
- "userId": {
- "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "late": {
- "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
- "enum": [
- "LATE_VALUES_UNSPECIFIED",
- "LATE_ONLY",
- "NOT_LATE_ONLY"
- ],
- "location": "query",
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifer of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly",
- "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
- "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
- ]
- },
- "get": {
- "id": "classroom.courses.courseWork.studentSubmissions.get",
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the student submission.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly",
- "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
- "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
- ]
- },
- "return": {
- "id": "classroom.courses.courseWork.studentSubmissions.return",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "ReturnStudentSubmissionRequest"
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the student submission.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ]
- },
- "patch": {
- "id": "classroom.courses.courseWork.studentSubmissions.patch",
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "StudentSubmission"
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "httpMethod": "PATCH",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "updateMask": {
- "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`",
- "location": "query",
- "type": "string",
- "format": "google-fieldmask"
- },
- "id": {
- "description": "Identifier of the student submission.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ]
- }
- }
- }
- },
- "methods": {
- "create": {
- "id": "classroom.courses.courseWork.create",
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId"
- ],
- "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
- "request": {
- "$ref": "CourseWork"
- },
- "flatPath": "v1/courses/{courseId}/courseWork",
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ]
- },
- "get": {
- "id": "classroom.courses.courseWork.get",
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the course work.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
- ]
- },
- "list": {
- "id": "classroom.courses.courseWork.list",
- "response": {
- "$ref": "ListCourseWorkResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
- "flatPath": "v1/courses/{courseId}/courseWork",
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "courseWorkStates": {
- "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.",
- "enum": [
- "COURSE_WORK_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
- "repeated": true,
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "orderBy": {
- "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
- ]
- },
- "patch": {
- "id": "classroom.courses.courseWork.patch",
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "CourseWork"
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "httpMethod": "PATCH",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "updateMask": {
- "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `submission_modification_mode`",
- "location": "query",
- "type": "string",
- "format": "google-fieldmask"
- },
- "id": {
- "description": "Identifier of the course work.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ]
- },
- "delete": {
- "id": "classroom.courses.courseWork.delete",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "httpMethod": "DELETE",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ]
- }
- }
- }
- },
"methods": {
"list": {
"id": "classroom.courses.list",
+ "path": "v1/courses",
+ "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
"response": {
"$ref": "ListCoursesResponse"
},
- "parameterOrder": [],
- "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.",
- "flatPath": "v1/courses",
- "httpMethod": "GET",
"parameters": {
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "teacherId": {
+ "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "location": "query"
+ },
"courseStates": {
- "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
+ "repeated": true,
+ "location": "query",
"enum": [
"COURSE_STATE_UNSPECIFIED",
"ACTIVE",
@@ -1107,370 +170,1287 @@
"DECLINED",
"SUSPENDED"
],
- "repeated": true,
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "teacherId": {
- "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "location": "query",
+ "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
"type": "string"
},
"studentId": {
"description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "location": "query",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
"location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
"type": "string"
}
},
- "path": "v1/courses",
"scopes": [
"https://www.googleapis.com/auth/classroom.courses",
"https://www.googleapis.com/auth/classroom.courses.readonly"
- ]
- },
- "get": {
- "id": "classroom.courses.get",
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [
- "id"
],
- "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "flatPath": "v1/courses/{id}",
- "httpMethod": "GET",
- "parameters": {
- "id": {
- "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ]
+ "flatPath": "v1/courses"
},
"create": {
- "id": "classroom.courses.create",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Course"
},
- "parameterOrder": [],
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {},
+ "flatPath": "v1/courses",
+ "id": "classroom.courses.create",
+ "path": "v1/courses",
"description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.",
"request": {
"$ref": "Course"
- },
- "flatPath": "v1/courses",
- "httpMethod": "POST",
- "parameters": {},
- "path": "v1/courses",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
+ }
},
- "update": {
- "id": "classroom.courses.update",
+ "get": {
"response": {
"$ref": "Course"
},
"parameterOrder": [
"id"
],
- "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
- "request": {
- "$ref": "Course"
- },
- "flatPath": "v1/courses/{id}",
- "httpMethod": "PUT",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
"parameters": {
"id": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ }
+ },
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.get",
+ "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Course"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {
+ "id": {
+ "location": "path",
"description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"required": true,
- "location": "path",
+ "type": "string"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
+ "format": "google-fieldmask",
"type": "string"
}
},
- "path": "v1/courses/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
- },
- "patch": {
+ "flatPath": "v1/courses/{id}",
"id": "classroom.courses.patch",
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [
- "id"
- ],
+ "path": "v1/courses/{id}",
"description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
"request": {
"$ref": "Course"
- },
- "flatPath": "v1/courses/{id}",
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
- "location": "query",
- "type": "string",
- "format": "google-fieldmask"
- },
- "id": {
- "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/courses/{id}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
+ }
},
- "delete": {
- "id": "classroom.courses.delete",
+ "update": {
+ "request": {
+ "$ref": "Course"
+ },
+ "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
"response": {
- "$ref": "Empty"
+ "$ref": "Course"
},
"parameterOrder": [
"id"
],
- "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "flatPath": "v1/courses/{id}",
- "httpMethod": "DELETE",
+ "httpMethod": "PUT",
"parameters": {
"id": {
- "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
"location": "path",
+ "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
"type": "string"
}
},
- "path": "v1/courses/{id}",
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
- ]
+ ],
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.update"
+ },
+ "delete": {
+ "id": "classroom.courses.delete",
+ "path": "v1/courses/{id}",
+ "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{id}"
}
- }
- },
- "userProfiles": {
+ },
"resources": {
- "guardians": {
+ "teachers": {
"methods": {
- "get": {
- "id": "classroom.userProfiles.guardians.get",
+ "create": {
"response": {
- "$ref": "Guardian"
+ "$ref": "Teacher"
},
"parameterOrder": [
- "studentId",
- "guardianId"
+ "courseId"
],
- "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.",
- "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "httpMethod": "GET",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
"parameters": {
- "studentId": {
- "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "courseId": {
"required": true,
+ "type": "string",
"location": "path",
- "type": "string"
- },
- "guardianId": {
- "description": "The `id` field from a `Guardian`.",
- "required": true,
- "location": "path",
- "type": "string"
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
}
},
- "path": "v1/userProfiles/{studentId}/guardians/{guardianId}"
- },
- "list": {
- "id": "classroom.userProfiles.guardians.list",
- "response": {
- "$ref": "ListGuardiansResponse"
- },
- "parameterOrder": [
- "studentId"
- ],
- "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
- "flatPath": "v1/userProfiles/{studentId}/guardians",
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "invitedEmailAddress": {
- "description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.",
- "location": "query",
- "type": "string"
- },
- "studentId": {
- "description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/userProfiles/{studentId}/guardians"
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "path": "v1/courses/{courseId}/teachers",
+ "id": "classroom.courses.teachers.create",
+ "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
+ "request": {
+ "$ref": "Teacher"
+ }
},
"delete": {
- "id": "classroom.userProfiles.guardians.delete",
+ "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "id": "classroom.courses.teachers.delete",
+ "path": "v1/courses/{courseId}/teachers/{userId}"
+ },
+ "get": {
+ "response": {
+ "$ref": "Teacher"
+ },
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "userId": {
+ "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "path": "v1/courses/{courseId}/teachers/{userId}",
+ "id": "classroom.courses.teachers.get",
+ "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListTeachersResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "path": "v1/courses/{courseId}/teachers",
+ "id": "classroom.courses.teachers.list",
+ "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors."
+ }
+ }
+ },
+ "aliases": {
+ "methods": {
+ "delete": {
+ "path": "v1/courses/{courseId}/aliases/{alias}",
+ "id": "classroom.courses.aliases.delete",
+ "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
- "studentId",
- "guardianId"
+ "courseId",
+ "alias"
],
- "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`.",
- "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
"httpMethod": "DELETE",
"parameters": {
- "studentId": {
- "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "alias": {
+ "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
"required": true,
- "location": "path",
- "type": "string"
+ "type": "string",
+ "location": "path"
},
- "guardianId": {
- "description": "The `id` field from a `Guardian`.",
+ "courseId": {
"required": true,
+ "type": "string",
"location": "path",
+ "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "flatPath": "v1/courses/{courseId}/aliases/{alias}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListCourseAliasesResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token."
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
"type": "string"
}
},
- "path": "v1/userProfiles/{studentId}/guardians/{guardianId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "path": "v1/courses/{courseId}/aliases",
+ "id": "classroom.courses.aliases.list",
+ "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "courseId"
+ ],
+ "response": {
+ "$ref": "CourseAlias"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "id": "classroom.courses.aliases.create",
+ "path": "v1/courses/{courseId}/aliases",
+ "description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to access a domain-scoped alias).",
+ "request": {
+ "$ref": "CourseAlias"
+ }
+ }
+ }
+ },
+ "students": {
+ "methods": {
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "parameters": {
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string"
+ },
+ "courseId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "path": "v1/courses/{courseId}/students/{userId}",
+ "id": "classroom.courses.students.get",
+ "description": "Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
+ "response": {
+ "$ref": "Student"
+ },
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "httpMethod": "GET"
+ },
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/students",
+ "path": "v1/courses/{courseId}/students",
+ "id": "classroom.courses.students.list",
+ "description": "Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
+ "response": {
+ "$ref": "ListStudentsResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET"
+ },
+ "create": {
+ "response": {
+ "$ref": "Student"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "enrollmentCode": {
+ "location": "query",
+ "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.",
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "flatPath": "v1/courses/{courseId}/students",
+ "path": "v1/courses/{courseId}/students",
+ "id": "classroom.courses.students.create",
+ "request": {
+ "$ref": "Student"
+ },
+ "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse."
+ },
+ "delete": {
+ "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string"
+ },
+ "courseId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "id": "classroom.courses.students.delete",
+ "path": "v1/courses/{courseId}/students/{userId}"
+ }
+ }
+ },
+ "courseWork": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "id": {
+ "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.delete",
+ "path": "v1/courses/{courseId}/courseWork/{id}"
+ },
+ "patch": {
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `submission_modification_mode`",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.patch",
+ "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "CourseWork"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
+ ],
+ "parameters": {
+ "courseId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.get",
+ "description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListCourseWorkResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "courseWorkStates": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "COURSE_WORK_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
+ ],
+ "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned."
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token."
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork",
+ "path": "v1/courses/{courseId}/courseWork",
+ "id": "classroom.courses.courseWork.list",
+ "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
+ },
+ "create": {
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork",
+ "path": "v1/courses/{courseId}/courseWork",
+ "id": "classroom.courses.courseWork.create",
+ "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
+ "request": {
+ "$ref": "CourseWork"
+ }
+ }
+ },
+ "resources": {
+ "studentSubmissions": {
+ "methods": {
+ "modifyAttachments": {
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
+ "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
+ "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "ModifyAttachmentsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ListStudentSubmissionsResponse"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "courseWorkId": {
+ "location": "path",
+ "description": "Identifer of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
+ "required": true,
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "late": {
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "LATE_VALUES_UNSPECIFIED",
+ "LATE_ONLY",
+ "NOT_LATE_ONLY"
+ ],
+ "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "states": {
+ "location": "query",
+ "enum": [
+ "SUBMISSION_STATE_UNSPECIFIED",
+ "NEW",
+ "CREATED",
+ "TURNED_IN",
+ "RETURNED",
+ "RECLAIMED_BY_STUDENT"
+ ],
+ "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
+ "type": "string",
+ "repeated": true
+ },
+ "userId": {
+ "location": "query",
+ "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly",
+ "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
+ "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
+ "id": "classroom.courses.courseWork.studentSubmissions.list",
+ "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
+ },
+ "get": {
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "id": "classroom.courses.courseWork.studentSubmissions.get",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly",
+ "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
+ "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "courseWorkId": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "patch": {
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "id": "classroom.courses.courseWork.studentSubmissions.patch",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "request": {
+ "$ref": "StudentSubmission"
+ },
+ "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`",
+ "format": "google-fieldmask"
+ },
+ "courseWorkId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the course work."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
+ },
+ "return": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "parameters": {
+ "courseWorkId": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the student submission."
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
+ "id": "classroom.courses.courseWork.studentSubmissions.return",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
+ "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "ReturnStudentSubmissionRequest"
+ }
+ },
+ "reclaim": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me"
+ ],
+ "parameters": {
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
+ "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
+ "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "ReclaimStudentSubmissionRequest"
+ }
+ },
+ "turnIn": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
+ "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
+ "request": {
+ "$ref": "TurnInStudentSubmissionRequest"
+ },
+ "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "userProfiles": {
+ "methods": {
+ "get": {
+ "path": "v1/userProfiles/{userId}",
+ "id": "classroom.userProfiles.get",
+ "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.",
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "parameters": {
+ "userId": {
+ "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/userProfiles/{userId}"
+ }
+ },
+ "resources": {
+ "guardians": {
+ "methods": {
+ "delete": {
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "studentId": {
+ "location": "path",
+ "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string"
+ },
+ "guardianId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The `id` field from a `Guardian`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
+ "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "id": "classroom.userProfiles.guardians.delete",
+ "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`."
+ },
+ "list": {
+ "path": "v1/userProfiles/{studentId}/guardians",
+ "id": "classroom.userProfiles.guardians.list",
+ "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
+ "parameterOrder": [
+ "studentId"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListGuardiansResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token."
+ },
+ "invitedEmailAddress": {
+ "location": "query",
+ "description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "studentId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view."
+ }
+ },
+ "flatPath": "v1/userProfiles/{studentId}/guardians"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "response": {
+ "$ref": "Guardian"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
+ "parameters": {
+ "studentId": {
+ "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "guardianId": {
+ "location": "path",
+ "description": "The `id` field from a `Guardian`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "id": "classroom.userProfiles.guardians.get",
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`."
}
}
},
"guardianInvitations": {
"methods": {
- "get": {
- "id": "classroom.userProfiles.guardianInvitations.get",
- "response": {
- "$ref": "GuardianInvitation"
- },
- "parameterOrder": [
- "studentId",
- "invitationId"
- ],
- "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.",
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "httpMethod": "GET",
- "parameters": {
- "invitationId": {
- "description": "The `id` field of the `GuardianInvitation` being requested.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "studentId": {
- "description": "The ID of the student whose guardian invitation is being requested.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"
- },
"create": {
- "id": "classroom.userProfiles.guardianInvitations.create",
"response": {
"$ref": "GuardianInvitation"
},
"parameterOrder": [
"studentId"
],
- "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.",
- "request": {
- "$ref": "GuardianInvitation"
- },
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
"httpMethod": "POST",
"parameters": {
"studentId": {
"description": "ID of the student (in standard format)",
"required": true,
- "location": "path",
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "path": "v1/userProfiles/{studentId}/guardianInvitations"
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "id": "classroom.userProfiles.guardianInvitations.create",
+ "request": {
+ "$ref": "GuardianInvitation"
+ },
+ "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user."
},
"list": {
- "id": "classroom.userProfiles.guardianInvitations.list",
+ "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
"response": {
"$ref": "ListGuardianInvitationsResponse"
},
"parameterOrder": [
"studentId"
],
- "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
"parameters": {
- "pageSize": {
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "invitedEmailAddress": {
- "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
- "location": "query",
- "type": "string"
- },
- "states": {
- "description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.",
- "enum": [
- "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
- "PENDING",
- "COMPLETE"
- ],
- "repeated": true,
- "location": "query",
- "type": "string"
- },
"studentId": {
+ "location": "path",
"description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.",
"required": true,
- "location": "path",
"type": "string"
},
"pageToken": {
"description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ },
+ "invitedEmailAddress": {
+ "type": "string",
"location": "query",
- "type": "string"
+ "description": "If specified, only results with the specified `invited_email_address`\nwill be returned."
+ },
+ "states": {
+ "description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.",
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
+ "PENDING",
+ "COMPLETE"
+ ]
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32"
}
},
- "path": "v1/userProfiles/{studentId}/guardianInvitations"
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "id": "classroom.userProfiles.guardianInvitations.list"
},
- "patch": {
- "id": "classroom.userProfiles.guardianInvitations.patch",
+ "get": {
+ "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "id": "classroom.userProfiles.guardianInvitations.get",
+ "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.",
"response": {
"$ref": "GuardianInvitation"
},
@@ -1478,168 +1458,257 @@
"studentId",
"invitationId"
],
+ "httpMethod": "GET",
+ "parameters": {
+ "invitationId": {
+ "location": "path",
+ "description": "The `id` field of the `GuardianInvitation` being requested.",
+ "required": true,
+ "type": "string"
+ },
+ "studentId": {
+ "location": "path",
+ "description": "The ID of the student whose guardian invitation is being requested.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"
+ },
+ "patch": {
"description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.",
"request": {
"$ref": "GuardianInvitation"
},
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
"httpMethod": "PATCH",
+ "parameterOrder": [
+ "studentId",
+ "invitationId"
+ ],
+ "response": {
+ "$ref": "GuardianInvitation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
"parameters": {
"invitationId": {
+ "location": "path",
"description": "The `id` field of the `GuardianInvitation` to be modified.",
"required": true,
- "location": "path",
"type": "string"
},
"updateMask": {
- "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `state`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
"location": "query",
- "type": "string",
- "format": "google-fieldmask"
+ "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `state`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
+ "format": "google-fieldmask",
+ "type": "string"
},
"studentId": {
+ "location": "path",
"description": "The ID of the student whose guardian invitation is to be modified.",
"required": true,
- "location": "path",
"type": "string"
}
},
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "id": "classroom.userProfiles.guardianInvitations.patch",
"path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"
}
}
}
- },
- "methods": {
- "get": {
- "id": "classroom.userProfiles.get",
- "response": {
- "$ref": "UserProfile"
- },
- "parameterOrder": [
- "userId"
- ],
- "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.",
- "flatPath": "v1/userProfiles/{userId}",
- "httpMethod": "GET",
- "parameters": {
- "userId": {
- "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "path": "v1/userProfiles/{userId}",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- }
}
}
},
- "schemas": {
- "Attachment": {
- "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
- "type": "object",
- "properties": {
- "driveFile": {
- "description": "Google Drive file attachment.",
- "$ref": "DriveFile"
- },
- "youTubeVideo": {
- "description": "Youtube video attachment.",
- "$ref": "YouTubeVideo"
- },
- "link": {
- "description": "Link attachment.",
- "$ref": "Link"
- },
- "form": {
- "description": "Google Forms attachment.",
- "$ref": "Form"
- }
- },
- "id": "Attachment"
+ "parameters": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
},
- "ListGuardianInvitationsResponse": {
- "description": "Response when listing guardian invitations.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "schemas": {
+ "ReclaimStudentSubmissionRequest": {
+ "properties": {},
+ "id": "ReclaimStudentSubmissionRequest",
+ "description": "Request to reclaim a student submission.",
+ "type": "object"
+ },
+ "AssignmentSubmission": {
+ "description": "Student work for an assignment.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "guardianInvitations": {
- "description": "Guardian invitations that matched the list request.",
+ "attachments": {
+ "description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (e.g. title) may not be.",
"type": "array",
"items": {
- "$ref": "GuardianInvitation"
+ "$ref": "Attachment"
}
}
},
- "id": "ListGuardianInvitationsResponse"
+ "id": "AssignmentSubmission"
+ },
+ "Material": {
+ "properties": {
+ "youtubeVideo": {
+ "$ref": "YouTubeVideo",
+ "description": "YouTube video material."
+ },
+ "driveFile": {
+ "description": "Google Drive file material.",
+ "$ref": "SharedDriveFile"
+ },
+ "form": {
+ "description": "Google Forms material.",
+ "$ref": "Form"
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response."
+ }
+ },
+ "id": "Material",
+ "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
+ "type": "object"
},
"CourseWork": {
"description": "Course work created by a teacher for students of the course.",
"type": "object",
"properties": {
- "id": {
- "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
- "type": "string"
- },
- "description": {
- "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
- "type": "string"
+ "state": {
+ "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
+ "type": "string",
+ "enumDescriptions": [
+ "No state specified. This is never returned.",
+ "Status for work that has been published.\nThis is the default state.",
+ "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.",
+ "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
+ ],
+ "enum": [
+ "COURSE_WORK_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
+ ]
},
"submissionModificationMode": {
- "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
- "enum": [
- "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
- "MODIFIABLE_UNTIL_TURNED_IN",
- "MODIFIABLE"
- ],
"enumDescriptions": [
"No modification mode specified. This is never returned.",
"Submisisons can be modified before being turned in.",
"Submisisons can be modified at any time."
],
+ "enum": [
+ "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
+ "MODIFIABLE_UNTIL_TURNED_IN",
+ "MODIFIABLE"
+ ],
+ "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
"type": "string"
},
- "associatedWithDeveloper": {
- "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
- "type": "boolean"
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
},
- "updateTime": {
- "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
- "type": "string",
- "format": "google-datetime"
+ "id": {
+ "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
+ "type": "string"
+ },
+ "dueTime": {
+ "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified.",
+ "$ref": "TimeOfDay"
},
"title": {
- "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
- "type": "string"
+ "type": "string",
+ "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters."
},
- "alternateLink": {
- "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
- "type": "string"
- },
- "workType": {
- "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
- "enum": [
- "COURSE_WORK_TYPE_UNSPECIFIED",
- "ASSIGNMENT",
- "SHORT_ANSWER_QUESTION",
- "MULTIPLE_CHOICE_QUESTION"
- ],
- "enumDescriptions": [
- "No work type specified. This is never returned.",
- "An assignment.",
- "A short answer question.",
- "A multiple-choice question."
- ],
- "type": "string"
+ "associatedWithDeveloper": {
+ "type": "boolean",
+ "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only."
},
"materials": {
"description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
@@ -1648,82 +1717,195 @@
"$ref": "Material"
}
},
- "state": {
- "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
- "enum": [
- "COURSE_WORK_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
- "enumDescriptions": [
- "No state specified. This is never returned.",
- "Status for work that has been published.\nThis is the default state.",
- "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.",
- "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
- ],
+ "updateTime": {
+ "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
+ "format": "google-datetime",
"type": "string"
},
- "dueDate": {
- "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified.",
- "$ref": "Date"
+ "alternateLink": {
+ "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
+ "type": "string"
+ },
+ "maxPoints": {
+ "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
+ "format": "double",
+ "type": "number"
+ },
+ "workType": {
+ "enumDescriptions": [
+ "No work type specified. This is never returned.",
+ "An assignment.",
+ "A short answer question.",
+ "A multiple-choice question."
+ ],
+ "enum": [
+ "COURSE_WORK_TYPE_UNSPECIFIED",
+ "ASSIGNMENT",
+ "SHORT_ANSWER_QUESTION",
+ "MULTIPLE_CHOICE_QUESTION"
+ ],
+ "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
+ "type": "string"
},
"multipleChoiceQuestion": {
"description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise.",
"$ref": "MultipleChoiceQuestion"
},
- "creationTime": {
- "description": "Timestamp when this course work was created.\n\nRead-only.",
- "type": "string",
- "format": "google-datetime"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "maxPoints": {
- "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
- "type": "number",
- "format": "double"
- },
"assignment": {
"description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only.",
"$ref": "Assignment"
},
- "dueTime": {
- "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified.",
- "$ref": "TimeOfDay"
+ "description": {
+ "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Timestamp when this course work was created.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "dueDate": {
+ "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified.",
+ "$ref": "Date"
}
},
"id": "CourseWork"
},
- "DriveFile": {
- "description": "Representation of a Google Drive file.",
+ "Guardian": {
+ "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.",
"type": "object",
"properties": {
- "thumbnailUrl": {
- "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.",
+ "studentId": {
+ "description": "Identifier for the student to whom the guardian relationship applies.",
"type": "string"
},
- "title": {
- "description": "Title of the Drive item.\n\nRead-only.",
+ "guardianId": {
+ "description": "Identifier for the guardian.",
"type": "string"
},
- "alternateLink": {
- "description": "URL that can be used to access the Drive item.\n\nRead-only.",
+ "invitedEmailAddress": {
+ "description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
"type": "string"
},
- "id": {
- "description": "Drive API resource ID.",
+ "guardianProfile": {
+ "$ref": "UserProfile",
+ "description": "User profile for the guardian."
+ }
+ },
+ "id": "Guardian"
+ },
+ "ListStudentsResponse": {
+ "description": "Response when listing students.",
+ "type": "object",
+ "properties": {
+ "students": {
+ "type": "array",
+ "items": {
+ "$ref": "Student"
+ },
+ "description": "Students who match the list request."
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
"type": "string"
}
},
- "id": "DriveFile"
+ "id": "ListStudentsResponse"
+ },
+ "UserProfile": {
+ "description": "Global information for a user.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Identifier of the user.\n\nRead-only.",
+ "type": "string"
+ },
+ "emailAddress": {
+ "description": "Email address of the user.\n\nRead-only.",
+ "type": "string"
+ },
+ "photoUrl": {
+ "description": "URL of user's profile photo.\n\nRead-only.",
+ "type": "string"
+ },
+ "permissions": {
+ "type": "array",
+ "items": {
+ "$ref": "GlobalPermission"
+ },
+ "description": "Global permissions of the user.\n\nRead-only."
+ },
+ "name": {
+ "$ref": "Name",
+ "description": "Name of the user.\n\nRead-only."
+ }
+ },
+ "id": "UserProfile"
+ },
+ "Student": {
+ "description": "Student in a course.",
+ "type": "object",
+ "properties": {
+ "profile": {
+ "$ref": "UserProfile",
+ "description": "Global user information for the student.\n\nRead-only."
+ },
+ "studentWorkFolder": {
+ "$ref": "DriveFolder",
+ "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only."
+ },
+ "userId": {
+ "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "id": "Student"
+ },
+ "Invitation": {
+ "description": "An invitation to join a course.",
+ "type": "object",
+ "properties": {
+ "userId": {
+ "type": "string",
+ "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
+ },
+ "courseId": {
+ "description": "Identifier of the course to invite the user to.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier assigned by Classroom.\n\nRead-only.",
+ "type": "string"
+ },
+ "role": {
+ "enum": [
+ "COURSE_ROLE_UNSPECIFIED",
+ "STUDENT",
+ "TEACHER"
+ ],
+ "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
+ "type": "string",
+ "enumDescriptions": [
+ "No course role.",
+ "Student in the course.",
+ "Teacher of the course."
+ ]
+ }
+ },
+ "id": "Invitation"
},
"DriveFolder": {
"description": "Representation of a Google Drive folder.",
"type": "object",
"properties": {
+ "id": {
+ "description": "Drive API resource ID.",
+ "type": "string"
+ },
"title": {
"description": "Title of the Drive folder.\n\nRead-only.",
"type": "string"
@@ -1731,32 +1913,10 @@
"alternateLink": {
"description": "URL that can be used to access the Drive folder.\n\nRead-only.",
"type": "string"
- },
- "id": {
- "description": "Drive API resource ID.",
- "type": "string"
}
},
"id": "DriveFolder"
},
- "ListCourseAliasesResponse": {
- "description": "Response when listing course aliases.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "aliases": {
- "description": "The course aliases.",
- "type": "array",
- "items": {
- "$ref": "CourseAlias"
- }
- }
- },
- "id": "ListCourseAliasesResponse"
- },
"ShortAnswerSubmission": {
"description": "Student work for a short answer question.",
"type": "object",
@@ -1768,58 +1928,132 @@
},
"id": "ShortAnswerSubmission"
},
- "CourseMaterial": {
- "description": "A material attached to a course as part of a material set.",
+ "StudentSubmission": {
+ "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
"type": "object",
"properties": {
- "driveFile": {
- "description": "Google Drive file attachment.",
- "$ref": "DriveFile"
+ "late": {
+ "description": "Whether this submission is late.\n\nRead-only.",
+ "type": "boolean"
},
- "youTubeVideo": {
- "description": "Youtube video attachment.",
- "$ref": "YouTubeVideo"
+ "draftGrade": {
+ "description": "Optional pending grade. If unset, no grade was set.\nThis must be a non-negative integer value.\n\nThis is only visible to and modifiable by course teachers.",
+ "format": "double",
+ "type": "number"
},
- "link": {
- "description": "Link atatchment.",
- "$ref": "Link"
+ "courseWorkType": {
+ "enumDescriptions": [
+ "No work type specified. This is never returned.",
+ "An assignment.",
+ "A short answer question.",
+ "A multiple-choice question."
+ ],
+ "enum": [
+ "COURSE_WORK_TYPE_UNSPECIFIED",
+ "ASSIGNMENT",
+ "SHORT_ANSWER_QUESTION",
+ "MULTIPLE_CHOICE_QUESTION"
+ ],
+ "description": "Type of course work this submission is for.\n\nRead-only.",
+ "type": "string"
},
- "form": {
- "description": "Google Forms attachment.",
- "$ref": "Form"
+ "creationTime": {
+ "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of this submission.\n\nRead-only.",
+ "type": "string",
+ "enumDescriptions": [
+ "No state specified. This should never be returned.",
+ "The student has never accessed this submission. Attachments are not\nreturned and timestamps is not set.",
+ "Has been created.",
+ "Has been turned in to the teacher.",
+ "Has been returned to the student.",
+ "Student chose to \"unsubmit\" the assignment."
+ ],
+ "enum": [
+ "SUBMISSION_STATE_UNSPECIFIED",
+ "NEW",
+ "CREATED",
+ "TURNED_IN",
+ "RETURNED",
+ "RECLAIMED_BY_STUDENT"
+ ]
+ },
+ "userId": {
+ "description": "Identifier for the student that owns this submission.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only."
+ },
+ "assignedGrade": {
+ "description": "Optional grade. If unset, no grade was set.\nThis must be a non-negative integer value.\n\nThis may be modified only by course teachers.",
+ "format": "double",
+ "type": "number"
+ },
+ "multipleChoiceSubmission": {
+ "$ref": "MultipleChoiceSubmission",
+ "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
+ },
+ "assignmentSubmission": {
+ "$ref": "AssignmentSubmission",
+ "description": "Submission content when course_work_type is ASSIGNMENT ."
+ },
+ "shortAnswerSubmission": {
+ "$ref": "ShortAnswerSubmission",
+ "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
+ },
+ "associatedWithDeveloper": {
+ "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "updateTime": {
+ "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "alternateLink": {
+ "type": "string",
+ "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only."
}
},
- "id": "CourseMaterial"
+ "id": "StudentSubmission"
},
- "MultipleChoiceSubmission": {
- "description": "Student work for a multiple-choice question.",
- "type": "object",
+ "ListStudentSubmissionsResponse": {
"properties": {
- "answer": {
- "description": "Student's select choice.",
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
"type": "string"
+ },
+ "studentSubmissions": {
+ "type": "array",
+ "items": {
+ "$ref": "StudentSubmission"
+ },
+ "description": "Student work that matches the request."
}
},
- "id": "MultipleChoiceSubmission"
+ "id": "ListStudentSubmissionsResponse",
+ "description": "Response when listing student submissions.",
+ "type": "object"
},
- "Link": {
- "description": "URL item.",
+ "TurnInStudentSubmissionRequest": {
+ "description": "Request to turn in a student submission.",
"type": "object",
- "properties": {
- "url": {
- "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
- "type": "string"
- },
- "thumbnailUrl": {
- "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
- "type": "string"
- },
- "title": {
- "description": "Title of the target of the URL.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "Link"
+ "properties": {},
+ "id": "TurnInStudentSubmissionRequest"
},
"ModifyAttachmentsRequest": {
"description": "Request to modify the attachments of a student submission.",
@@ -1835,41 +2069,199 @@
},
"id": "ModifyAttachmentsRequest"
},
+ "ListCourseWorkResponse": {
+ "description": "Response when listing course work.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
+ },
+ "courseWork": {
+ "description": "Course work items that match the request.",
+ "type": "array",
+ "items": {
+ "$ref": "CourseWork"
+ }
+ }
+ },
+ "id": "ListCourseWorkResponse"
+ },
+ "YouTubeVideo": {
+ "description": "YouTube video item.",
+ "type": "object",
+ "properties": {
+ "alternateLink": {
+ "description": "URL that can be used to view the YouTube video.\n\nRead-only.",
+ "type": "string"
+ },
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "YouTube API resource ID.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of the YouTube video.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "id": "YouTubeVideo"
+ },
+ "ListInvitationsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "invitations": {
+ "description": "Invitations that match the list request.",
+ "type": "array",
+ "items": {
+ "$ref": "Invitation"
+ }
+ }
+ },
+ "id": "ListInvitationsResponse",
+ "description": "Response when listing invitations.",
+ "type": "object"
+ },
+ "GuardianInvitation": {
+ "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
+ "type": "object",
+ "properties": {
+ "creationTime": {
+ "description": "The time that this invitation was created.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "invitationId": {
+ "description": "Unique identifier for this invitation.\n\nRead-only.",
+ "type": "string"
+ },
+ "studentId": {
+ "type": "string",
+ "description": "ID of the student (in standard format)"
+ },
+ "state": {
+ "enum": [
+ "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
+ "PENDING",
+ "COMPLETE"
+ ],
+ "description": "The state that this invitation is in.",
+ "type": "string",
+ "enumDescriptions": [
+ "Should never be returned.",
+ "The invitation is active and awaiting a response.",
+ "The invitation is no longer active. It may have been accepted, declined,\nwithdrawn or it may have expired."
+ ]
+ },
+ "invitedEmailAddress": {
+ "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
+ "type": "string"
+ }
+ },
+ "id": "GuardianInvitation"
+ },
+ "Attachment": {
+ "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
+ "type": "object",
+ "properties": {
+ "form": {
+ "$ref": "Form",
+ "description": "Google Forms attachment."
+ },
+ "link": {
+ "description": "Link attachment.",
+ "$ref": "Link"
+ },
+ "driveFile": {
+ "$ref": "DriveFile",
+ "description": "Google Drive file attachment."
+ },
+ "youTubeVideo": {
+ "description": "Youtube video attachment.",
+ "$ref": "YouTubeVideo"
+ }
+ },
+ "id": "Attachment"
+ },
+ "CourseMaterialSet": {
+ "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "Title for this set.",
+ "type": "string"
+ },
+ "materials": {
+ "description": "Materials attached to this set.",
+ "type": "array",
+ "items": {
+ "$ref": "CourseMaterial"
+ }
+ }
+ },
+ "id": "CourseMaterialSet"
+ },
"TimeOfDay": {
"description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
"type": "object",
"properties": {
- "nanos": {
- "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
- "type": "integer",
- "format": "int32"
- },
- "hours": {
- "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
- "type": "integer",
- "format": "int32"
+ "seconds": {
+ "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
+ "format": "int32",
+ "type": "integer"
},
"minutes": {
"description": "Minutes of hour of day. Must be from 0 to 59.",
- "type": "integer",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
- "seconds": {
- "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
- "type": "integer",
- "format": "int32"
+ "hours": {
+ "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "nanos": {
+ "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "TimeOfDay"
},
- "Form": {
- "description": "Google Forms item.",
+ "ListCoursesResponse": {
"type": "object",
"properties": {
+ "courses": {
+ "description": "Courses that match the list request.",
+ "type": "array",
+ "items": {
+ "$ref": "Course"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "id": "ListCoursesResponse",
+ "description": "Response when listing courses."
+ },
+ "Form": {
+ "properties": {
"thumbnailUrl": {
"description": "URL of a thumbnail image of the Form.\n\nRead-only.",
"type": "string"
},
+ "responseUrl": {
+ "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.",
+ "type": "string"
+ },
"formUrl": {
"description": "URL of the form.",
"type": "string"
@@ -1877,278 +2269,11 @@
"title": {
"description": "Title of the Form.\n\nRead-only.",
"type": "string"
- },
- "responseUrl": {
- "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.",
- "type": "string"
}
},
- "id": "Form"
- },
- "MultipleChoiceQuestion": {
- "description": "Additional details for multiple-choice questions.",
- "type": "object",
- "properties": {
- "choices": {
- "description": "Possible choices.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "MultipleChoiceQuestion"
- },
- "CourseMaterialSet": {
- "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
- "type": "object",
- "properties": {
- "materials": {
- "description": "Materials attached to this set.",
- "type": "array",
- "items": {
- "$ref": "CourseMaterial"
- }
- },
- "title": {
- "description": "Title for this set.",
- "type": "string"
- }
- },
- "id": "CourseMaterialSet"
- },
- "StudentSubmission": {
- "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
- "type": "string"
- },
- "courseWorkType": {
- "description": "Type of course work this submission is for.\n\nRead-only.",
- "enum": [
- "COURSE_WORK_TYPE_UNSPECIFIED",
- "ASSIGNMENT",
- "SHORT_ANSWER_QUESTION",
- "MULTIPLE_CHOICE_QUESTION"
- ],
- "enumDescriptions": [
- "No work type specified. This is never returned.",
- "An assignment.",
- "A short answer question.",
- "A multiple-choice question."
- ],
- "type": "string"
- },
- "assignedGrade": {
- "description": "Optional grade. If unset, no grade was set.\nThis must be a non-negative integer value.\n\nThis may be modified only by course teachers.",
- "type": "number",
- "format": "double"
- },
- "associatedWithDeveloper": {
- "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
- "type": "boolean"
- },
- "updateTime": {
- "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
- "type": "string",
- "format": "google-datetime"
- },
- "alternateLink": {
- "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
- "type": "string"
- },
- "draftGrade": {
- "description": "Optional pending grade. If unset, no grade was set.\nThis must be a non-negative integer value.\n\nThis is only visible to and modifiable by course teachers.",
- "type": "number",
- "format": "double"
- },
- "userId": {
- "description": "Identifier for the student that owns this submission.\n\nRead-only.",
- "type": "string"
- },
- "multipleChoiceSubmission": {
- "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.",
- "$ref": "MultipleChoiceSubmission"
- },
- "state": {
- "description": "State of this submission.\n\nRead-only.",
- "enum": [
- "SUBMISSION_STATE_UNSPECIFIED",
- "NEW",
- "CREATED",
- "TURNED_IN",
- "RETURNED",
- "RECLAIMED_BY_STUDENT"
- ],
- "enumDescriptions": [
- "No state specified. This should never be returned.",
- "The student has never accessed this submission. Attachments are not\nreturned and timestamps is not set.",
- "Has been created.",
- "Has been turned in to the teacher.",
- "Has been returned to the student.",
- "Student chose to \"unsubmit\" the assignment."
- ],
- "type": "string"
- },
- "assignmentSubmission": {
- "description": "Submission content when course_work_type is ASSIGNMENT .",
- "$ref": "AssignmentSubmission"
- },
- "creationTime": {
- "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
- "type": "string",
- "format": "google-datetime"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "shortAnswerSubmission": {
- "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION.",
- "$ref": "ShortAnswerSubmission"
- },
- "late": {
- "description": "Whether this submission is late.\n\nRead-only.",
- "type": "boolean"
- },
- "courseWorkId": {
- "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "StudentSubmission"
- },
- "CourseAlias": {
- "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.",
- "type": "object",
- "properties": {
- "alias": {
- "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:\u003cname\u003e` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:\u003cname\u003e` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.",
- "type": "string"
- }
- },
- "id": "CourseAlias"
- },
- "ListGuardiansResponse": {
- "description": "Response when listing guardians.",
- "type": "object",
- "properties": {
- "guardians": {
- "description": "Guardians on this page of results that met the criteria specified in\nthe request.",
- "type": "array",
- "items": {
- "$ref": "Guardian"
- }
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- }
- },
- "id": "ListGuardiansResponse"
- },
- "Guardian": {
- "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.",
- "type": "object",
- "properties": {
- "guardianProfile": {
- "description": "User profile for the guardian.",
- "$ref": "UserProfile"
- },
- "invitedEmailAddress": {
- "description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
- "type": "string"
- },
- "studentId": {
- "description": "Identifier for the student to whom the guardian relationship applies.",
- "type": "string"
- },
- "guardianId": {
- "description": "Identifier for the guardian.",
- "type": "string"
- }
- },
- "id": "Guardian"
- },
- "Teacher": {
- "description": "Teacher of a course.",
- "type": "object",
- "properties": {
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "profile": {
- "description": "Global user information for the teacher.\n\nRead-only.",
- "$ref": "UserProfile"
- },
- "userId": {
- "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
- }
- },
- "id": "Teacher"
- },
- "UserProfile": {
- "description": "Global information for a user.",
- "type": "object",
- "properties": {
- "emailAddress": {
- "description": "Email address of the user.\n\nRead-only.",
- "type": "string"
- },
- "permissions": {
- "description": "Global permissions of the user.\n\nRead-only.",
- "type": "array",
- "items": {
- "$ref": "GlobalPermission"
- }
- },
- "id": {
- "description": "Identifier of the user.\n\nRead-only.",
- "type": "string"
- },
- "name": {
- "description": "Name of the user.\n\nRead-only.",
- "$ref": "Name"
- },
- "photoUrl": {
- "description": "URL of user's profile photo.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "UserProfile"
- },
- "ReclaimStudentSubmissionRequest": {
- "description": "Request to reclaim a student submission.",
- "type": "object",
- "properties": {},
- "id": "ReclaimStudentSubmissionRequest"
- },
- "Student": {
- "description": "Student in a course.",
- "type": "object",
- "properties": {
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "profile": {
- "description": "Global user information for the student.\n\nRead-only.",
- "$ref": "UserProfile"
- },
- "studentWorkFolder": {
- "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only.",
- "$ref": "DriveFolder"
- },
- "userId": {
- "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
- }
- },
- "id": "Student"
+ "id": "Form",
+ "description": "Google Forms item.",
+ "type": "object"
},
"ListTeachersResponse": {
"description": "Response when listing teachers.",
@@ -2168,386 +2293,147 @@
},
"id": "ListTeachersResponse"
},
- "Course": {
- "description": "A Course in Classroom.",
+ "Link": {
+ "description": "URL item.",
"type": "object",
"properties": {
- "id": {
- "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.",
- "type": "string"
- },
- "description": {
- "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.",
- "type": "string"
- },
- "updateTime": {
- "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
- "type": "string",
- "format": "google-datetime"
- },
- "section": {
- "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.",
- "type": "string"
- },
- "alternateLink": {
- "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
- "type": "string"
- },
- "teacherGroupEmail": {
- "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
- "type": "string"
- },
- "guardiansEnabled": {
- "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
- "type": "boolean"
- },
- "ownerId": {
- "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Specifying this field in a course\nupdate mask results in an `INVALID_ARGUMENT` error.",
- "type": "string"
- },
- "descriptionHeading": {
- "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
- "type": "string"
- },
- "courseGroupEmail": {
- "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
- "type": "string"
- },
- "courseState": {
- "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
- "enum": [
- "COURSE_STATE_UNSPECIFIED",
- "ACTIVE",
- "ARCHIVED",
- "PROVISIONED",
- "DECLINED",
- "SUSPENDED"
- ],
- "enumDescriptions": [
- "No course state. No returned Course message will use this value.",
- "The course is active.",
- "The course has been archived. You cannot modify it except to change it\nto a different state.",
- "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.",
- "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.",
- "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service."
- ],
- "type": "string"
- },
- "room": {
- "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.",
- "type": "string"
- },
- "name": {
- "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.",
- "type": "string"
- },
- "creationTime": {
- "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
- "type": "string",
- "format": "google-datetime"
- },
- "enrollmentCode": {
- "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
- "type": "string"
- },
- "teacherFolder": {
- "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only.",
- "$ref": "DriveFolder"
- },
- "courseMaterialSets": {
- "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
- "type": "array",
- "items": {
- "$ref": "CourseMaterialSet"
- }
- }
- },
- "id": "Course"
- },
- "ReturnStudentSubmissionRequest": {
- "description": "Request to return a student submission.",
- "type": "object",
- "properties": {},
- "id": "ReturnStudentSubmissionRequest"
- },
- "GuardianInvitation": {
- "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
- "type": "object",
- "properties": {
- "creationTime": {
- "description": "The time that this invitation was created.\n\nRead-only.",
- "type": "string",
- "format": "google-datetime"
- },
- "invitationId": {
- "description": "Unique identifier for this invitation.\n\nRead-only.",
- "type": "string"
- },
- "state": {
- "description": "The state that this invitation is in.",
- "enum": [
- "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
- "PENDING",
- "COMPLETE"
- ],
- "enumDescriptions": [
- "Should never be returned.",
- "The invitation is active and awaiting a response.",
- "The invitation is no longer active. It may have been accepted, declined,\nwithdrawn or it may have expired."
- ],
- "type": "string"
- },
- "invitedEmailAddress": {
- "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
- "type": "string"
- },
- "studentId": {
- "description": "ID of the student (in standard format)",
- "type": "string"
- }
- },
- "id": "GuardianInvitation"
- },
- "TurnInStudentSubmissionRequest": {
- "description": "Request to turn in a student submission.",
- "type": "object",
- "properties": {},
- "id": "TurnInStudentSubmissionRequest"
- },
- "YouTubeVideo": {
- "description": "YouTube video item.",
- "type": "object",
- "properties": {
- "thumbnailUrl": {
- "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
+ "url": {
+ "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
"type": "string"
},
"title": {
- "description": "Title of the YouTube video.\n\nRead-only.",
+ "description": "Title of the target of the URL.\n\nRead-only.",
"type": "string"
},
- "alternateLink": {
- "description": "URL that can be used to view the YouTube video.\n\nRead-only.",
- "type": "string"
- },
- "id": {
- "description": "YouTube API resource ID.",
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
"type": "string"
}
},
- "id": "YouTubeVideo"
+ "id": "Link"
},
- "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"
+ "ListGuardiansResponse": {
+ "properties": {
+ "guardians": {
+ "description": "Guardians on this page of results that met the criteria specified in\nthe request.",
+ "type": "array",
+ "items": {
+ "$ref": "Guardian"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "id": "ListGuardiansResponse",
+ "description": "Response when listing guardians.",
+ "type": "object"
},
- "ListCourseWorkResponse": {
- "description": "Response when listing course work.",
+ "ListGuardianInvitationsResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
"type": "string"
},
- "courseWork": {
- "description": "Course work items that match the request.",
+ "guardianInvitations": {
+ "description": "Guardian invitations that matched the list request.",
"type": "array",
"items": {
- "$ref": "CourseWork"
+ "$ref": "GuardianInvitation"
}
}
},
- "id": "ListCourseWorkResponse"
+ "id": "ListGuardianInvitationsResponse",
+ "description": "Response when listing guardian invitations."
},
- "SharedDriveFile": {
- "description": "Drive file that is used as material for course work.",
+ "ListCourseAliasesResponse": {
+ "description": "Response when listing course aliases.",
"type": "object",
"properties": {
- "driveFile": {
- "description": "Drive file details.",
- "$ref": "DriveFile"
- },
- "shareMode": {
- "description": "Mechanism by which students access the Drive item.",
- "enum": [
- "UNKNOWN_SHARE_MODE",
- "VIEW",
- "EDIT",
- "STUDENT_COPY"
- ],
- "enumDescriptions": [
- "No sharing mode specified. This should never be returned.",
- "Students can view the shared file.",
- "Students can edit the shared file.",
- "Students have a personal copy of the shared file."
- ],
- "type": "string"
- }
- },
- "id": "SharedDriveFile"
- },
- "GlobalPermission": {
- "description": "Global user permission description.",
- "type": "object",
- "properties": {
- "permission": {
- "description": "Permission value.",
- "enum": [
- "PERMISSION_UNSPECIFIED",
- "CREATE_COURSE"
- ],
- "enumDescriptions": [
- "No permission is specified. This is not returned and is not a\nvalid value.",
- "User is permitted to create a course."
- ],
- "type": "string"
- }
- },
- "id": "GlobalPermission"
- },
- "Material": {
- "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
- "type": "object",
- "properties": {
- "driveFile": {
- "description": "Google Drive file material.",
- "$ref": "SharedDriveFile"
- },
- "link": {
- "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response.",
- "$ref": "Link"
- },
- "youtubeVideo": {
- "description": "YouTube video material.",
- "$ref": "YouTubeVideo"
- },
- "form": {
- "description": "Google Forms material.",
- "$ref": "Form"
- }
- },
- "id": "Material"
- },
- "AssignmentSubmission": {
- "description": "Student work for an assignment.",
- "type": "object",
- "properties": {
- "attachments": {
- "description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (e.g. title) may not be.",
+ "aliases": {
"type": "array",
"items": {
- "$ref": "Attachment"
- }
+ "$ref": "CourseAlias"
+ },
+ "description": "The course aliases."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
}
},
- "id": "AssignmentSubmission"
+ "id": "ListCourseAliasesResponse"
+ },
+ "CourseAlias": {
+ "type": "object",
+ "properties": {
+ "alias": {
+ "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:\u003cname\u003e` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:\u003cname\u003e` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.",
+ "type": "string"
+ }
+ },
+ "id": "CourseAlias",
+ "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded."
},
"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",
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32"
},
"day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
- "type": "integer",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "Date"
},
- "Assignment": {
- "description": "Additional details for assignments.",
+ "MultipleChoiceSubmission": {
+ "description": "Student work for a multiple-choice question.",
"type": "object",
"properties": {
- "studentWorkFolder": {
- "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers.",
- "$ref": "DriveFolder"
+ "answer": {
+ "description": "Student's select choice.",
+ "type": "string"
}
},
- "id": "Assignment"
+ "id": "MultipleChoiceSubmission"
},
- "ListCoursesResponse": {
- "description": "Response when listing courses.",
- "type": "object",
+ "CourseMaterial": {
"properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
+ "driveFile": {
+ "$ref": "DriveFile",
+ "description": "Google Drive file attachment."
},
- "courses": {
- "description": "Courses that match the list request.",
- "type": "array",
- "items": {
- "$ref": "Course"
- }
+ "youTubeVideo": {
+ "$ref": "YouTubeVideo",
+ "description": "Youtube video attachment."
+ },
+ "form": {
+ "$ref": "Form",
+ "description": "Google Forms attachment."
+ },
+ "link": {
+ "description": "Link atatchment.",
+ "$ref": "Link"
}
},
- "id": "ListCoursesResponse"
- },
- "Invitation": {
- "description": "An invitation to join a course.",
- "type": "object",
- "properties": {
- "courseId": {
- "description": "Identifier of the course to invite the user to.",
- "type": "string"
- },
- "role": {
- "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
- "enum": [
- "COURSE_ROLE_UNSPECIFIED",
- "STUDENT",
- "TEACHER"
- ],
- "enumDescriptions": [
- "No course role.",
- "Student in the course.",
- "Teacher of the course."
- ],
- "type": "string"
- },
- "userId": {
- "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
- },
- "id": {
- "description": "Identifier assigned by Classroom.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "Invitation"
- },
- "ListStudentSubmissionsResponse": {
- "description": "Response when listing student submissions.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "studentSubmissions": {
- "description": "Student work that matches the request.",
- "type": "array",
- "items": {
- "$ref": "StudentSubmission"
- }
- }
- },
- "id": "ListStudentSubmissionsResponse"
+ "id": "CourseMaterial",
+ "description": "A material attached to a course as part of a material set.",
+ "type": "object"
},
"Name": {
- "description": "Details of the user's name.",
"type": "object",
"properties": {
"givenName": {
@@ -2563,148 +2449,298 @@
"type": "string"
}
},
- "id": "Name"
+ "id": "Name",
+ "description": "Details of the user's name."
},
- "ListInvitationsResponse": {
- "description": "Response when listing invitations.",
+ "Assignment": {
+ "description": "Additional details for assignments.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
+ "studentWorkFolder": {
+ "$ref": "DriveFolder",
+ "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers."
+ }
+ },
+ "id": "Assignment"
+ },
+ "SharedDriveFile": {
+ "type": "object",
+ "properties": {
+ "driveFile": {
+ "description": "Drive file details.",
+ "$ref": "DriveFile"
},
- "invitations": {
- "description": "Invitations that match the list request.",
+ "shareMode": {
+ "enumDescriptions": [
+ "No sharing mode specified. This should never be returned.",
+ "Students can view the shared file.",
+ "Students can edit the shared file.",
+ "Students have a personal copy of the shared file."
+ ],
+ "enum": [
+ "UNKNOWN_SHARE_MODE",
+ "VIEW",
+ "EDIT",
+ "STUDENT_COPY"
+ ],
+ "description": "Mechanism by which students access the Drive item.",
+ "type": "string"
+ }
+ },
+ "id": "SharedDriveFile",
+ "description": "Drive file that is used as material for course work."
+ },
+ "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": {}
+ },
+ "MultipleChoiceQuestion": {
+ "description": "Additional details for multiple-choice questions.",
+ "type": "object",
+ "properties": {
+ "choices": {
+ "description": "Possible choices.",
"type": "array",
"items": {
- "$ref": "Invitation"
+ "type": "string"
}
}
},
- "id": "ListInvitationsResponse"
+ "id": "MultipleChoiceQuestion"
},
- "ListStudentsResponse": {
- "description": "Response when listing students.",
+ "Course": {
+ "description": "A Course in Classroom.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "id": {
+ "type": "string",
+ "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error."
+ },
+ "room": {
+ "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.",
"type": "string"
},
- "students": {
- "description": "Students who match the list request.",
+ "courseGroupEmail": {
+ "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
+ "type": "string"
+ },
+ "enrollmentCode": {
+ "type": "string",
+ "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only."
+ },
+ "courseMaterialSets": {
+ "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
"type": "array",
"items": {
- "$ref": "Student"
+ "$ref": "CourseMaterialSet"
}
+ },
+ "descriptionHeading": {
+ "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "alternateLink": {
+ "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
+ "type": "string"
+ },
+ "guardiansEnabled": {
+ "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "ownerId": {
+ "type": "string",
+ "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Specifying this field in a course\nupdate mask results in an `INVALID_ARGUMENT` error."
+ },
+ "courseState": {
+ "enumDescriptions": [
+ "No course state. No returned Course message will use this value.",
+ "The course is active.",
+ "The course has been archived. You cannot modify it except to change it\nto a different state.",
+ "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.",
+ "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.",
+ "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service."
+ ],
+ "enum": [
+ "COURSE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "ARCHIVED",
+ "PROVISIONED",
+ "DECLINED",
+ "SUSPENDED"
+ ],
+ "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.",
+ "type": "string"
+ },
+ "teacherGroupEmail": {
+ "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.",
+ "type": "string"
+ },
+ "teacherFolder": {
+ "$ref": "DriveFolder",
+ "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only."
+ },
+ "section": {
+ "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.",
+ "type": "string"
}
},
- "id": "ListStudentsResponse"
+ "id": "Course"
+ },
+ "DriveFile": {
+ "description": "Representation of a Google Drive file.",
+ "type": "object",
+ "properties": {
+ "alternateLink": {
+ "description": "URL that can be used to access the Drive item.\n\nRead-only.",
+ "type": "string"
+ },
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Drive API resource ID.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of the Drive item.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "id": "DriveFile"
+ },
+ "ReturnStudentSubmissionRequest": {
+ "description": "Request to return a student submission.",
+ "type": "object",
+ "properties": {},
+ "id": "ReturnStudentSubmissionRequest"
+ },
+ "GlobalPermission": {
+ "properties": {
+ "permission": {
+ "description": "Permission value.",
+ "type": "string",
+ "enumDescriptions": [
+ "No permission is specified. This is not returned and is not a\nvalid value.",
+ "User is permitted to create a course."
+ ],
+ "enum": [
+ "PERMISSION_UNSPECIFIED",
+ "CREATE_COURSE"
+ ]
+ }
+ },
+ "id": "GlobalPermission",
+ "description": "Global user permission description.",
+ "type": "object"
+ },
+ "Teacher": {
+ "properties": {
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "profile": {
+ "description": "Global user information for the teacher.\n\nRead-only.",
+ "$ref": "UserProfile"
+ },
+ "userId": {
+ "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ }
+ },
+ "id": "Teacher",
+ "description": "Teacher of a course.",
+ "type": "object"
}
},
- "revision": "20170314",
- "basePath": "",
+ "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"
},
- "discoveryVersion": "v1",
+ "version": "v1",
"baseUrl": "https://classroom.googleapis.com/",
- "name": "classroom",
- "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"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students": {
+ "description": "View and manage guardians for students in your Google Classroom classes"
+ },
+ "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": {
+ "description": "View your course work and grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly": {
+ "description": "View your Google Classroom guardians"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly": {
+ "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.students": {
+ "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
+ "description": "View your course work and grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.profile.emails": {
+ "description": "View the email addresses of people in your classes"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.me": {
+ "description": "Manage your course work and view your grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.rosters": {
+ "description": "Manage your Google Classroom class rosters"
+ },
+ "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
+ "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
+ },
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": {
+ "description": "View guardians for students in your Google Classroom classes"
+ },
+ "https://www.googleapis.com/auth/classroom.courses": {
+ "description": "Manage your Google Classroom classes"
+ },
+ "https://www.googleapis.com/auth/classroom.courses.readonly": {
+ "description": "View your Google Classroom classes"
+ },
+ "https://www.googleapis.com/auth/classroom.profile.photos": {
+ "description": "View the profile photos of people in your classes"
+ },
+ "https://www.googleapis.com/auth/classroom.rosters.readonly": {
+ "description": "View your Google Classroom class rosters"
+ }
+ }
}
},
- "documentationLink": "https://developers.google.com/classroom/",
- "ownerDomain": "google.com",
- "batchPath": "batch",
"servicePath": "",
- "ownerName": "Google",
- "version": "v1",
+ "description": "Manages classes, rosters, and invitations in Google Classroom.",
+ "kind": "discovery#restDescription",
"rootUrl": "https://classroom.googleapis.com/",
- "kind": "discovery#restDescription"
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "classroom",
+ "batchPath": "batch",
+ "revision": "20170601",
+ "documentationLink": "https://developers.google.com/classroom/",
+ "id": "classroom:v1"
}
diff --git a/classroom/v1/classroom-gen.go b/classroom/v1/classroom-gen.go
index 4bbc292..efbc7db 100644
--- a/classroom/v1/classroom-gen.go
+++ b/classroom/v1/classroom-gen.go
@@ -68,6 +68,16 @@
// classes you teach or administer
ClassroomCourseworkStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
+ // View your Google Classroom guardians
+ ClassroomGuardianlinksMeReadonlyScope = "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly"
+
+ // View and manage guardians for students in your Google Classroom
+ // classes
+ ClassroomGuardianlinksStudentsScope = "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+
+ // View guardians for students in your Google Classroom classes
+ ClassroomGuardianlinksStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+
// View the email addresses of people in your classes
ClassroomProfileEmailsScope = "https://www.googleapis.com/auth/classroom.profile.emails"
@@ -8525,7 +8535,10 @@
// },
// "response": {
// "$ref": "GuardianInvitation"
- // }
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ // ]
// }
}
@@ -8689,7 +8702,11 @@
// "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
// "response": {
// "$ref": "GuardianInvitation"
- // }
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ // ]
// }
}
@@ -8921,7 +8938,11 @@
// "path": "v1/userProfiles/{studentId}/guardianInvitations",
// "response": {
// "$ref": "ListGuardianInvitationsResponse"
- // }
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ // ]
// }
}
@@ -9131,7 +9152,10 @@
// },
// "response": {
// "$ref": "GuardianInvitation"
- // }
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ // ]
// }
}
@@ -9286,7 +9310,10 @@
// "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
// "response": {
// "$ref": "Empty"
- // }
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ // ]
// }
}
@@ -9452,7 +9479,12 @@
// "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
// "response": {
// "$ref": "Guardian"
- // }
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ // ]
// }
}
@@ -9667,7 +9699,12 @@
// "path": "v1/userProfiles/{studentId}/guardians",
// "response": {
// "$ref": "ListGuardiansResponse"
- // }
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ // "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ // ]
// }
}
diff --git a/cloudbuild/v1/cloudbuild-api.json b/cloudbuild/v1/cloudbuild-api.json
index 24f481b..fa05fd2 100644
--- a/cloudbuild/v1/cloudbuild-api.json
+++ b/cloudbuild/v1/cloudbuild-api.json
@@ -1,4 +1,6 @@
{
+ "rootUrl": "https://cloudbuild.googleapis.com/",
+ "ownerDomain": "google.com",
"name": "cloudbuild",
"batchPath": "batch",
"title": "Google Cloud Container Builder API",
@@ -6,99 +8,99 @@
"resources": {
"operations": {
"methods": {
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding 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": {
- "pattern": "^operations$",
- "location": "path",
- "description": "The name of the operation collection.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The standard list page token."
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "cloudbuild.operations.list"
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "id": "cloudbuild.operations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ]
- },
"cancel": {
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "cloudbuild.operations.cancel",
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
"request": {
"$ref": "CancelOperationRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"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": "^operations/.+$"
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ }
+ },
+ "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 allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list filter."
+ },
+ "name": {
+ "pattern": "^operations$",
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
}
},
- "flatPath": "v1/operations/{operationsId}:cancel",
- "id": "cloudbuild.operations.cancel",
- "path": "v1/{+name}:cancel"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations"
+ },
+ "get": {
+ "response": {
+ "$ref": "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": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "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."
}
}
},
@@ -106,83 +108,25 @@
"resources": {
"triggers": {
"methods": {
- "get": {
- "response": {
- "$ref": "BuildTrigger"
- },
+ "delete": {
+ "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
"parameterOrder": [
"projectId",
"triggerId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "triggerId": {
- "location": "path",
- "description": "ID of the BuildTrigger to get.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "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.get",
- "description": "Gets information about a BuildTrigger.\n\nThis API is experimental."
- },
- "list": {
- "flatPath": "v1/projects/{projectId}/triggers",
- "path": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.list",
- "description": "Lists existing BuildTrigger.\n\nThis API is experimental.",
+ "httpMethod": "DELETE",
"response": {
- "$ref": "ListBuildTriggersResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "ID of the project for which to list BuildTriggers."
- }
- }
- },
- "patch": {
- "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
- "request": {
- "$ref": "BuildTrigger"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "response": {
- "$ref": "BuildTrigger"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"triggerId": {
- "description": "ID of the BuildTrigger to update.",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "ID of the BuildTrigger to delete."
},
"projectId": {
"required": true,
@@ -192,17 +136,99 @@
}
},
"flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.patch",
- "path": "v1/projects/{projectId}/triggers/{triggerId}"
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.delete"
},
- "create": {
+ "get": {
"response": {
"$ref": "BuildTrigger"
},
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.get",
+ "description": "Gets information about a BuildTrigger.\n\nThis API is experimental."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListBuildTriggersResponse"
+ },
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project for which to list BuildTriggers.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/triggers",
+ "path": "v1/projects/{projectId}/triggers",
+ "id": "cloudbuild.projects.triggers.list",
+ "description": "Lists existing BuildTrigger.\n\nThis API is experimental."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "parameters": {
+ "triggerId": {
+ "description": "ID of the BuildTrigger to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "ID of the project that owns the trigger.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.patch",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "request": {
+ "$ref": "BuildTrigger"
+ },
+ "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental."
+ },
+ "create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -215,154 +241,28 @@
}
},
"flatPath": "v1/projects/{projectId}/triggers",
- "path": "v1/projects/{projectId}/triggers",
"id": "cloudbuild.projects.triggers.create",
+ "path": "v1/projects/{projectId}/triggers",
"description": "Creates a new BuildTrigger.\n\nThis API is experimental.",
"request": {
"$ref": "BuildTrigger"
- }
- },
- "delete": {
- "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
},
+ "httpMethod": "POST",
"parameterOrder": [
- "projectId",
- "triggerId"
+ "projectId"
],
- "parameters": {
- "triggerId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "ID of the BuildTrigger to delete."
- },
- "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}",
- "id": "cloudbuild.projects.triggers.delete",
- "path": "v1/projects/{projectId}/triggers/{triggerId}"
+ "response": {
+ "$ref": "BuildTrigger"
+ }
}
}
},
"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": {
- "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.",
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "GET",
- "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}"
- },
- "list": {
- "response": {
- "$ref": "ListBuildsResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Token to provide to skip to a particular spot in the list."
- },
- "pageSize": {
- "location": "query",
- "description": "Number of results to return in the list.",
- "format": "int32",
- "type": "integer"
- },
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "ID of the project."
- },
- "filter": {
- "description": "The raw filter text to constrain the results.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "create": {
"flatPath": "v1/projects/{projectId}/builds",
"path": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.list",
- "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully."
- },
- "create": {
+ "id": "cloudbuild.projects.builds.create",
"request": {
"$ref": "Build"
},
@@ -384,10 +284,112 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "cancel": {
+ "request": {
+ "$ref": "CancelBuildRequest"
+ },
+ "description": "Cancels a requested build in progress.",
+ "response": {
+ "$ref": "Build"
+ },
+ "parameterOrder": [
+ "projectId",
+ "id"
],
+ "httpMethod": "POST",
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "ID of the build.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
+ "path": "v1/projects/{projectId}/builds/{id}:cancel",
+ "id": "cloudbuild.projects.builds.cancel"
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "description": "ID of the build.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Build"
+ },
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ]
+ },
+ "list": {
+ "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBuildsResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The raw filter text to constrain the results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Token to provide to skip to a particular spot in the list.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Number of results to return in the list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the project."
+ }
+ },
"flatPath": "v1/projects/{projectId}/builds",
- "path": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.create"
+ "id": "cloudbuild.projects.builds.list",
+ "path": "v1/projects/{projectId}/builds"
}
}
}
@@ -395,20 +397,52 @@
}
},
"parameters": {
- "fields": {
+ "quotaUser": {
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
+ "pp": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"callback": {
+ "type": "string",
"location": "query",
- "description": "JSONP",
- "type": "string"
+ "description": "JSONP"
},
"$.xgafv": {
"description": "V1 error format.",
@@ -440,139 +474,29 @@
]
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "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."
- },
- "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://cloudbuild.googleapis.com/",
- "servicePath": "",
- "description": "Builds container images in the cloud.",
"kind": "discovery#restDescription",
+ "description": "Builds container images in the cloud.",
+ "servicePath": "",
"basePath": "",
- "revision": "20170510",
"documentationLink": "https://cloud.google.com/container-builder/docs/",
+ "revision": "20170605",
"id": "cloudbuild:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "SourceProvenance": {
- "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.",
- "type": "object",
- "properties": {
- "fileHashes": {
- "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"
- }
- },
- "resolvedRepoSource": {
- "$ref": "RepoSource",
- "description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved."
- },
- "resolvedStorageSource": {
- "$ref": "StorageSource",
- "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved."
- }
- },
- "id": "SourceProvenance"
- },
- "CancelOperationRequest": {
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation."
- },
- "ListBuildTriggersResponse": {
- "description": "Response containing existing BuildTriggers.",
- "type": "object",
- "properties": {
- "triggers": {
- "type": "array",
- "items": {
- "$ref": "BuildTrigger"
- },
- "description": "BuildTriggers for the project, sorted by create_time descending."
- }
- },
- "id": "ListBuildTriggersResponse"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "Operation"
- },
"BuiltImage": {
- "description": "BuiltImage describes an image built by the pipeline.",
"type": "object",
"properties": {
"name": {
@@ -584,18 +508,11 @@
"type": "string"
}
},
- "id": "BuiltImage"
+ "id": "BuiltImage",
+ "description": "BuiltImage describes an image built by the pipeline."
},
"Hash": {
- "id": "Hash",
- "description": "Container message for hash values.",
- "type": "object",
"properties": {
- "value": {
- "type": "string",
- "description": "The hash value.",
- "format": "byte"
- },
"type": {
"enumDescriptions": [
"No hash requested.",
@@ -607,20 +524,28 @@
],
"description": "The type of hash that was performed.",
"type": "string"
+ },
+ "value": {
+ "description": "The hash value.",
+ "format": "byte",
+ "type": "string"
}
- }
+ },
+ "id": "Hash",
+ "description": "Container message for hash values.",
+ "type": "object"
},
"RepoSource": {
"description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
"type": "object",
"properties": {
"projectId": {
- "type": "string",
- "description": "ID of the project that owns the repo. If omitted, the project ID requesting\nthe build is assumed."
+ "description": "ID of the project that owns the repo. If omitted, the project ID requesting\nthe build is assumed.",
+ "type": "string"
},
"repoName": {
- "type": "string",
- "description": "Name of the repo. If omitted, the name \"default\" is assumed."
+ "description": "Name of the repo. If omitted, the name \"default\" is assumed.",
+ "type": "string"
},
"branchName": {
"description": "Name of the branch to build.",
@@ -638,22 +563,20 @@
"id": "RepoSource"
},
"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\".",
+ "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"
}
},
- "waitFor": {
- "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in wait_for\nhave completed successfully. If wait_for is empty, this build step will\nstart when all previous build steps in the Build.Steps list have completed\nsuccessfully.",
+ "env": {
+ "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".",
"type": "array",
"items": {
"type": "string"
@@ -671,18 +594,19 @@
"type": "string"
},
"entrypoint": {
- "description": "Optional entrypoint to be used instead of the build step image's default\nIf unset, the image's default will be used.",
- "type": "string"
+ "type": "string",
+ "description": "Optional entrypoint to be used instead of the build step image's default\nIf unset, the image's default will be used."
},
"id": {
- "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.",
- "type": "string"
+ "type": "string",
+ "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency."
}
},
- "id": "BuildStep"
+ "id": "BuildStep",
+ "description": "BuildStep describes a step to perform in the build pipeline.",
+ "type": "object"
},
"FileHashes": {
- "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.",
"type": "object",
"properties": {
"fileHash": {
@@ -693,59 +617,66 @@
}
}
},
- "id": "FileHashes"
+ "id": "FileHashes",
+ "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build."
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"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."
+ "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"
- }
+ },
+ "type": "object"
}
+ },
+ "code": {
+ "type": "integer",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32"
}
},
"id": "Status"
},
"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": {}
},
"BuildTrigger": {
- "id": "BuildTrigger",
"description": "Configuration for an automated build in response to source repository\nchanges.",
"type": "object",
"properties": {
+ "substitutions": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Substitutions data for Build resource.",
+ "type": "object"
+ },
"description": {
"description": "Human-readable description of this trigger.",
"type": "string"
},
- "disabled": {
- "description": "If true, the trigger will never result in a build.",
- "type": "boolean"
- },
"createTime": {
"description": "Time when the trigger was created.\n\n@OutputOnly",
"format": "google-datetime",
"type": "string"
},
+ "disabled": {
+ "description": "If true, the trigger will never result in a build.",
+ "type": "boolean"
+ },
"triggerTemplate": {
"$ref": "RepoSource",
"description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build."
@@ -761,20 +692,35 @@
"build": {
"description": "Contents of the build template.",
"$ref": "Build"
- },
- "substitutions": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Substitutions data for Build resource.",
- "type": "object"
}
- }
+ },
+ "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": {
+ "images": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE."
+ },
+ "projectId": {
+ "description": "ID of the project.\n@OutputOnly.",
+ "type": "string"
+ },
+ "finishTime": {
+ "description": "Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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."
@@ -789,6 +735,7 @@
"type": "string"
},
"status": {
+ "description": "Status of the build.\n@OutputOnly",
"type": "string",
"enumDescriptions": [
"Status of the build is unknown.",
@@ -809,21 +756,20 @@
"INTERNAL_ERROR",
"TIMEOUT",
"CANCELLED"
- ],
- "description": "Status of the build.\n@OutputOnly"
+ ]
},
"statusDetail": {
"description": "Customer-readable message about the current status.\n@OutputOnly",
"type": "string"
},
- "results": {
- "$ref": "Results",
- "description": "Results of the build.\n@OutputOnly"
- },
"logsBucket": {
"description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.",
"type": "string"
},
+ "results": {
+ "$ref": "Results",
+ "description": "Results of the build.\n@OutputOnly"
+ },
"steps": {
"description": "Describes the operations to be performed on the workspace.",
"type": "array",
@@ -835,10 +781,6 @@
"description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly",
"type": "string"
},
- "id": {
- "description": "Unique identifier of the build.\n@OutputOnly",
- "type": "string"
- },
"tags": {
"description": "Tags for annotation of a Build. These are not docker tags.",
"type": "array",
@@ -846,63 +788,46 @@
"type": "string"
}
},
- "substitutions": {
- "description": "Substitutions data for Build resource.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the build.\n@OutputOnly"
},
"startTime": {
"type": "string",
"description": "Time at which execution of the build was started.\n@OutputOnly",
"format": "google-datetime"
},
+ "substitutions": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Substitutions data for Build resource.",
+ "type": "object"
+ },
"sourceProvenance": {
- "description": "A permanent fixed identifier for source.\n@OutputOnly",
- "$ref": "SourceProvenance"
+ "$ref": "SourceProvenance",
+ "description": "A permanent fixed identifier for source.\n@OutputOnly"
},
"createTime": {
+ "type": "string",
"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"
- }
- },
- "projectId": {
- "description": "ID of the project.\n@OutputOnly.",
- "type": "string"
- },
- "finishTime": {
- "description": "Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "logUrl": {
- "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly",
- "type": "string"
+ "format": "google-datetime"
}
- },
- "id": "Build"
+ }
},
"CancelBuildRequest": {
+ "properties": {},
"id": "CancelBuildRequest",
"description": "Request to cancel an ongoing build.",
- "type": "object",
- "properties": {}
+ "type": "object"
},
"ListBuildsResponse": {
"description": "Response including listed builds.",
"type": "object",
"properties": {
"nextPageToken": {
- "description": "Token to receive the next page of results.",
- "type": "string"
+ "type": "string",
+ "description": "Token to receive the next page of results."
},
"builds": {
"description": "Builds will be sorted by create_time, descending.",
@@ -915,26 +840,24 @@
"id": "ListBuildsResponse"
},
"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"
},
"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.",
@@ -945,27 +868,15 @@
"$ref": "RepoSource"
}
},
- "id": "Source"
+ "id": "Source",
+ "description": "Source describes the location of the source in a supported storage\nservice.",
+ "type": "object"
},
"BuildOptions": {
+ "id": "BuildOptions",
"description": "Optional arguments to enable specific features of builds.",
"type": "object",
"properties": {
- "sourceProvenanceHash": {
- "description": "Requested hash for SourceProvenance.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "NONE",
- "SHA256"
- ]
- },
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ]
- },
"requestedVerifyOption": {
"type": "string",
"enumDescriptions": [
@@ -977,68 +888,159 @@
"VERIFIED"
],
"description": "Requested verifiability options."
+ },
+ "sourceProvenanceHash": {
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ],
+ "description": "Requested hash for SourceProvenance.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "NONE",
+ "SHA256"
+ ],
+ "type": "string"
+ }
}
- },
- "id": "BuildOptions"
+ }
},
"StorageSource": {
+ "id": "StorageSource",
"description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage.",
"type": "object",
"properties": {
- "bucket": {
- "description": "Google Cloud Storage bucket containing source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).",
- "type": "string"
- },
"object": {
"description": "Google Cloud Storage object containing source.\n\nThis object must be a gzipped archive file (.tar.gz) containing source to\nbuild.",
"type": "string"
},
"generation": {
+ "type": "string",
"description": "Google Cloud Storage generation for the object. If the generation is\nomitted, the latest generation will be used.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
+ },
+ "bucket": {
+ "type": "string",
+ "description": "Google Cloud Storage bucket containing source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements))."
}
- },
- "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"
},
"BuildOperationMetadata": {
- "id": "BuildOperationMetadata",
- "description": "Metadata for build operations.",
"type": "object",
"properties": {
"build": {
"$ref": "Build",
"description": "The build that the operation is tracking."
}
- }
+ },
+ "id": "BuildOperationMetadata",
+ "description": "Metadata for build operations."
+ },
+ "SourceProvenance": {
+ "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.",
+ "type": "object",
+ "properties": {
+ "resolvedRepoSource": {
+ "description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved.",
+ "$ref": "RepoSource"
+ },
+ "resolvedStorageSource": {
+ "$ref": "StorageSource",
+ "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved."
+ },
+ "fileHashes": {
+ "additionalProperties": {
+ "$ref": "FileHashes"
+ },
+ "description": "Hash(es) of the build source, which can be used to verify that the original\nsource integrity was maintained in the build. Note that FileHashes will\nonly be populated if BuildOptions has requested a SourceProvenanceHash.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will be for the single path to that file.\n@OutputOnly",
+ "type": "object"
+ }
+ },
+ "id": "SourceProvenance"
+ },
+ "CancelOperationRequest": {
+ "properties": {},
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "type": "string",
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`."
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "Operation"
+ },
+ "ListBuildTriggersResponse": {
+ "description": "Response containing existing BuildTriggers.",
+ "type": "object",
+ "properties": {
+ "triggers": {
+ "type": "array",
+ "items": {
+ "$ref": "BuildTrigger"
+ },
+ "description": "BuildTriggers for the project, sorted by create_time descending."
+ }
+ },
+ "id": "ListBuildTriggersResponse"
}
},
- "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud Build",
"auth": {
"oauth2": {
@@ -1048,7 +1050,5 @@
}
}
}
- },
- "rootUrl": "https://cloudbuild.googleapis.com/",
- "ownerDomain": "google.com"
+ }
}
diff --git a/cloudbuild/v1/cloudbuild-gen.go b/cloudbuild/v1/cloudbuild-gen.go
index 05767d8..809835c 100644
--- a/cloudbuild/v1/cloudbuild-gen.go
+++ b/cloudbuild/v1/cloudbuild-gen.go
@@ -1475,9 +1475,18 @@
// server doesn't support this method, it returns
// `UNIMPLEMENTED`.
//
-// NOTE: the `name` binding below allows API services to override the
+// NOTE: the `name` binding allows API services to override the
// binding
// to use different resource name schemes, such as `users/*/operations`.
+// To
+// override the binding, API services can add a binding such
+// as
+// "/v1/{name=users/*}/operations" to their service configuration.
+// For backwards compatibility, the default name includes the
+// operations
+// collection id, however overriding users must ensure the name
+// binding
+// is the parent resource, without the operations collection id.
func (r *OperationsService) List(name string) *OperationsListCall {
c := &OperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -1599,7 +1608,7 @@
}
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`.",
+ // "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
// "flatPath": "v1/operations",
// "httpMethod": "GET",
// "id": "cloudbuild.operations.list",
@@ -1613,7 +1622,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "path",
// "pattern": "^operations$",
// "required": true,
diff --git a/clouddebugger/v2/clouddebugger-api.json b/clouddebugger/v2/clouddebugger-api.json
index ae2b2da..697278c 100644
--- a/clouddebugger/v2/clouddebugger-api.json
+++ b/clouddebugger/v2/clouddebugger-api.json
@@ -2,26 +2,151 @@
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "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.",
+ "StackFrame": {
+ "properties": {
+ "arguments": {
+ "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
+ "type": "array",
+ "items": {
+ "$ref": "Variable"
+ }
+ },
+ "locals": {
+ "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.",
+ "type": "array",
+ "items": {
+ "$ref": "Variable"
+ }
+ },
+ "location": {
+ "$ref": "SourceLocation",
+ "description": "Source location of the call site."
+ },
+ "function": {
+ "description": "Demangled function name at the call site.",
+ "type": "string"
+ }
+ },
+ "id": "StackFrame",
+ "description": "Represents a stack frame context.",
+ "type": "object"
+ },
+ "RepoId": {
+ "description": "A unique identifier for a cloud repo.",
"type": "object",
"properties": {
- "project": {
- "description": "Project the debuggee is associated with.\nUse the project number when registering a Google Cloud Platform project.",
+ "uid": {
+ "description": "A server-assigned, globally unique identifier.",
"type": "string"
},
- "isDisabled": {
- "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.",
- "type": "boolean"
+ "projectRepoId": {
+ "description": "A combination of a project ID and a repo name.",
+ "$ref": "ProjectRepoId"
+ }
+ },
+ "id": "RepoId"
+ },
+ "FormatMessage": {
+ "properties": {
+ "parameters": {
+ "description": "Optional parameters to be embedded into the message.",
+ "type": "array",
+ "items": {
+ "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`).",
+ "format": {
+ "description": "Format template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n* `Please pay $$10 to use $0 instead of $1.`",
+ "type": "string"
+ }
+ },
+ "id": "FormatMessage",
+ "description": "Represents a message with parameters.",
+ "type": "object"
+ },
+ "ExtendedSourceContext": {
+ "description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
+ "type": "object",
+ "properties": {
+ "context": {
+ "$ref": "SourceContext",
+ "description": "Any source context."
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels with user defined metadata.",
+ "type": "object"
+ }
+ },
+ "id": "ExtendedSourceContext"
+ },
+ "AliasContext": {
+ "properties": {
+ "name": {
+ "description": "The alias name.",
"type": "string"
},
- "id": {
- "description": "Unique identifier for the debuggee generated by the controller service.",
- "type": "string"
+ "kind": {
+ "enum": [
+ "ANY",
+ "FIXED",
+ "MOVABLE",
+ "OTHER"
+ ],
+ "description": "The alias kind.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use.",
+ "Git tag",
+ "Git branch",
+ "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
+ ]
+ }
+ },
+ "id": "AliasContext",
+ "description": "An alias to a repo revision.",
+ "type": "object"
+ },
+ "ListDebuggeesResponse": {
+ "description": "Response for listing debuggees.",
+ "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"
+ }
+ }
+ },
+ "id": "ListDebuggeesResponse"
+ },
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
+ },
+ "SourceLocation": {
+ "properties": {
+ "line": {
+ "description": "Line inside the file. The first line in the file has the value `1`.",
+ "format": "int32",
+ "type": "integer"
},
+ "path": {
+ "description": "Path to the source file within the source context of the target binary.",
+ "type": "string"
+ }
+ },
+ "id": "SourceLocation",
+ "description": "Represents a location in the source code.",
+ "type": "object"
+ },
+ "Debuggee": {
+ "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"
@@ -45,26 +170,42 @@
}
},
"labels": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user."
+ "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object"
},
"isInactive": {
"description": "If set to `true`, indicates that the debuggee is considered as inactive by\nthe Controller service.",
"type": "boolean"
},
"status": {
- "$ref": "StatusMessage",
- "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status."
+ "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status.",
+ "$ref": "StatusMessage"
+ },
+ "project": {
+ "description": "Project the debuggee is associated with.\nUse the project number when registering a Google Cloud Platform project.",
+ "type": "string"
+ },
+ "isDisabled": {
+ "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.",
+ "type": "boolean"
+ },
+ "agentVersion": {
+ "description": "Version ID of the agent 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"
+ "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.",
@@ -75,49 +216,63 @@
"type": "string"
}
},
- "id": "ProjectRepoId"
+ "id": "ProjectRepoId",
+ "description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.",
+ "type": "object"
},
"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"
- },
- "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each 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"
+ },
+ "nextWaitToken": {
+ "description": "A wait token that can be used in the next method call to block until\nthe list of breakpoints changes.",
+ "type": "string"
}
},
"id": "ListActiveBreakpointsResponse"
},
"CloudWorkspaceSourceContext": {
+ "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
+ "type": "object",
"properties": {
"snapshotId": {
- "type": "string",
- "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot."
+ "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
+ "type": "string"
},
"workspaceId": {
"$ref": "CloudWorkspaceId",
"description": "The ID of the workspace."
}
},
- "id": "CloudWorkspaceSourceContext",
- "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
+ "id": "CloudWorkspaceSourceContext"
+ },
+ "UpdateActiveBreakpointResponse": {
+ "properties": {},
+ "id": "UpdateActiveBreakpointResponse",
+ "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.",
"type": "object"
},
"GerritSourceContext": {
- "description": "A SourceContext referring to a Gerrit project.",
- "type": "object",
"properties": {
+ "gerritProject": {
+ "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
+ "type": "string"
+ },
+ "aliasContext": {
+ "$ref": "AliasContext",
+ "description": "An alias, which may be a branch or tag."
+ },
"hostUri": {
"description": "The URI of a running Gerrit instance.",
"type": "string"
@@ -129,33 +284,21 @@
"aliasName": {
"description": "The name of an alias (branch, tag, etc.).",
"type": "string"
- },
- "gerritProject": {
- "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
- "type": "string"
- },
- "aliasContext": {
- "description": "An alias, which may be a branch or tag.",
- "$ref": "AliasContext"
}
},
- "id": "GerritSourceContext"
- },
- "UpdateActiveBreakpointResponse": {
- "properties": {},
- "id": "UpdateActiveBreakpointResponse",
- "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.",
+ "id": "GerritSourceContext",
+ "description": "A SourceContext referring to a Gerrit project.",
"type": "object"
},
"CloudWorkspaceId": {
"properties": {
- "repoId": {
- "description": "The ID of the repo containing the workspace.",
- "$ref": "RepoId"
- },
"name": {
"description": "The unique name of the workspace within the repo. This is the name\nchosen by the client in the Source API's CreateWorkspace method.",
"type": "string"
+ },
+ "repoId": {
+ "$ref": "RepoId",
+ "description": "The ID of the repo containing the workspace."
}
},
"id": "CloudWorkspaceId",
@@ -164,16 +307,16 @@
},
"ListBreakpointsResponse": {
"properties": {
- "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"
- },
"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",
@@ -184,6 +327,58 @@
"description": "Represents the breakpoint specification, status and results.",
"type": "object",
"properties": {
+ "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"
+ },
+ "createTime": {
+ "description": "Time this breakpoint was created by the server in seconds resolution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "logMessageFormat": {
+ "description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.",
+ "type": "string"
+ },
+ "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"
@@ -230,58 +425,6 @@
"description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.",
"format": "google-datetime",
"type": "string"
- },
- "variableTable": {
- "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
- },
- "createTime": {
- "type": "string",
- "description": "Time this breakpoint was created by the server in seconds resolution.",
- "format": "google-datetime"
- },
- "logMessageFormat": {
- "description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.",
- "type": "string"
- },
- "labels": {
- "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object",
- "additionalProperties": {
- "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"
}
},
"id": "Breakpoint"
@@ -291,8 +434,8 @@
"type": "object",
"properties": {
"breakpoint": {
- "$ref": "Breakpoint",
- "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)."
+ "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds).",
+ "$ref": "Breakpoint"
}
},
"id": "SetBreakpointResponse"
@@ -309,13 +452,7 @@
"id": "UpdateActiveBreakpointRequest"
},
"SourceContext": {
- "description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.",
- "type": "object",
"properties": {
- "git": {
- "$ref": "GitSourceContext",
- "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
- },
"gerrit": {
"description": "A SourceContext referring to a Gerrit project.",
"$ref": "GerritSourceContext"
@@ -325,23 +462,20 @@
"$ref": "CloudRepoSourceContext"
},
"cloudWorkspace": {
- "description": "A SourceContext referring to a snapshot in a cloud workspace.",
- "$ref": "CloudWorkspaceSourceContext"
+ "$ref": "CloudWorkspaceSourceContext",
+ "description": "A SourceContext referring to a snapshot in a cloud workspace."
+ },
+ "git": {
+ "description": "A SourceContext referring to any third party Git repo (e.g. GitHub).",
+ "$ref": "GitSourceContext"
}
},
- "id": "SourceContext"
+ "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"
},
"CloudRepoSourceContext": {
- "type": "object",
"properties": {
- "repoId": {
- "description": "The ID of the repo.",
- "$ref": "RepoId"
- },
- "aliasContext": {
- "$ref": "AliasContext",
- "description": "An alias, which may be a branch or tag."
- },
"revisionId": {
"description": "A revision ID.",
"type": "string"
@@ -349,12 +483,22 @@
"aliasName": {
"description": "The name of an alias (branch, tag, etc.).",
"type": "string"
+ },
+ "repoId": {
+ "description": "The ID of the repo.",
+ "$ref": "RepoId"
+ },
+ "aliasContext": {
+ "$ref": "AliasContext",
+ "description": "An alias, which may be a branch or tag."
}
},
"id": "CloudRepoSourceContext",
- "description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform)."
+ "description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).",
+ "type": "object"
},
"RegisterDebuggeeRequest": {
+ "description": "Request to register a debuggee.",
"type": "object",
"properties": {
"debuggee": {
@@ -362,27 +506,26 @@
"description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
}
},
- "id": "RegisterDebuggeeRequest",
- "description": "Request to register a debuggee."
+ "id": "RegisterDebuggeeRequest"
},
"RegisterDebuggeeResponse": {
- "description": "Response for registering a debuggee.",
- "type": "object",
"properties": {
"debuggee": {
"description": "Debuggee resource.\nThe field `id` is guranteed to be set (in addition to the echoed fields).",
"$ref": "Debuggee"
}
},
- "id": "RegisterDebuggeeResponse"
+ "id": "RegisterDebuggeeResponse",
+ "description": "Response for registering a debuggee.",
+ "type": "object"
},
"GetBreakpointResponse": {
"description": "Response for getting breakpoint information.",
"type": "object",
"properties": {
"breakpoint": {
- "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set.",
- "$ref": "Breakpoint"
+ "$ref": "Breakpoint",
+ "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set."
}
},
"id": "GetBreakpointResponse"
@@ -394,12 +537,10 @@
"type": "boolean"
},
"description": {
- "$ref": "FormatMessage",
- "description": "Status message text."
+ "description": "Status message text.",
+ "$ref": "FormatMessage"
},
"refersTo": {
- "description": "Reference to which the message applies.",
- "type": "string",
"enumDescriptions": [
"Status doesn't refer to any particular input.",
"Status applies to the breakpoint and is related to its location.",
@@ -417,7 +558,9 @@
"BREAKPOINT_AGE",
"VARIABLE_NAME",
"VARIABLE_VALUE"
- ]
+ ],
+ "description": "Reference to which the message applies.",
+ "type": "string"
}
},
"id": "StatusMessage",
@@ -425,6 +568,7 @@
"type": "object"
},
"GitSourceContext": {
+ "description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).",
"type": "object",
"properties": {
"revisionId": {
@@ -436,24 +580,10 @@
"type": "string"
}
},
- "id": "GitSourceContext",
- "description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub)."
+ "id": "GitSourceContext"
},
"Variable": {
- "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.",
- "type": "object",
"properties": {
- "members": {
- "description": "Members contained or pointed to by the variable.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
- },
- "status": {
- "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`",
- "$ref": "StatusMessage"
- },
"name": {
"description": "Name of the variable, if any.",
"type": "string"
@@ -470,168 +600,38 @@
"value": {
"description": "Simple value of the variable.",
"type": "string"
- }
- },
- "id": "Variable"
- },
- "StackFrame": {
- "description": "Represents a stack frame context.",
- "type": "object",
- "properties": {
- "location": {
- "description": "Source location of the call site.",
- "$ref": "SourceLocation"
},
- "function": {
- "description": "Demangled function name at the call site.",
- "type": "string"
- },
- "arguments": {
- "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
+ "members": {
+ "description": "Members contained or pointed to by the variable.",
"type": "array",
"items": {
"$ref": "Variable"
}
},
- "locals": {
- "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
+ "status": {
+ "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`",
+ "$ref": "StatusMessage"
}
},
- "id": "StackFrame"
- },
- "RepoId": {
- "id": "RepoId",
- "description": "A unique identifier for a cloud repo.",
- "type": "object",
- "properties": {
- "uid": {
- "description": "A server-assigned, globally unique identifier.",
- "type": "string"
- },
- "projectRepoId": {
- "$ref": "ProjectRepoId",
- "description": "A combination of a project ID and a repo name."
- }
- }
- },
- "FormatMessage": {
- "description": "Represents a message with parameters.",
- "type": "object",
- "properties": {
- "parameters": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Optional parameters to be embedded into the message."
- },
- "format": {
- "description": "Format template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n* `Please pay $$10 to use $0 instead of $1.`",
- "type": "string"
- }
- },
- "id": "FormatMessage"
- },
- "ExtendedSourceContext": {
- "description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
- "type": "object",
- "properties": {
- "context": {
- "description": "Any source context.",
- "$ref": "SourceContext"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels with user defined metadata.",
- "type": "object"
- }
- },
- "id": "ExtendedSourceContext"
- },
- "ListDebuggeesResponse": {
- "description": "Response for listing debuggees.",
- "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"
- }
- }
- },
- "id": "ListDebuggeesResponse"
- },
- "AliasContext": {
- "description": "An alias to a repo revision.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The alias name.",
- "type": "string"
- },
- "kind": {
- "enum": [
- "ANY",
- "FIXED",
- "MOVABLE",
- "OTHER"
- ],
- "description": "The alias kind.",
- "type": "string",
- "enumDescriptions": [
- "Do not use.",
- "Git tag",
- "Git branch",
- "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
- ]
- }
- },
- "id": "AliasContext"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "SourceLocation": {
- "description": "Represents a location in the source code.",
- "type": "object",
- "properties": {
- "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"
+ "id": "Variable",
+ "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.",
+ "type": "object"
}
},
- "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 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 +648,42 @@
"debuggees": {
"methods": {
"list": {
- "description": "Lists all the debuggees that the user can set breakpoints to.",
"response": {
"$ref": "ListDebuggeesResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
"parameters": {
- "clientVersion": {
- "location": "query",
- "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- },
"includeInactive": {
+ "location": "query",
"description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"project": {
"location": "query",
"description": "Project number of a Google Cloud project whose debuggees to list.",
"type": "string"
+ },
+ "clientVersion": {
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string",
+ "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
"flatPath": "v2/debugger/debuggees",
"path": "v2/debugger/debuggees",
- "id": "clouddebugger.debugger.debuggees.list"
+ "id": "clouddebugger.debugger.debuggees.list",
+ "description": "Lists all the debuggees that the user can set breakpoints to."
}
},
"resources": {
"breakpoints": {
"methods": {
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "clientVersion": {
- "location": "query",
- "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- },
- "breakpointId": {
- "description": "ID of the breakpoint to get.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "debuggeeId": {
- "description": "ID of the debuggee whose breakpoint to get.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "id": "clouddebugger.debugger.debuggees.breakpoints.get",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "description": "Gets breakpoint information.",
- "httpMethod": "GET",
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "response": {
- "$ref": "GetBreakpointResponse"
- }
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "debuggeeId"
- ],
- "response": {
- "$ref": "ListBreakpointsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "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": {
- "location": "query",
- "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- },
- "action.value": {
- "location": "query",
- "enum": [
- "CAPTURE",
- "LOG"
- ],
- "description": "Only breakpoints with the specified action will pass the filter.",
- "type": "string"
- },
- "includeAllUsers": {
- "location": "query",
- "description": "When set to `true`, the response includes the list of breakpoints set by\nany user. Otherwise, it includes only breakpoints set by the caller.",
- "type": "boolean"
- },
- "includeInactive": {
- "location": "query",
- "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
- "type": "boolean"
- },
- "stripResults": {
- "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
- "type": "boolean",
- "location": "query"
- },
- "debuggeeId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "ID of the debuggee whose breakpoints to list."
- }
- },
- "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": {
- "request": {
- "$ref": "Breakpoint"
- },
- "description": "Sets the breakpoint to the debuggee.",
"httpMethod": "POST",
"parameterOrder": [
"debuggeeId"
@@ -791,6 +691,10 @@
"response": {
"$ref": "SetBreakpointResponse"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
"parameters": {
"clientVersion": {
"location": "query",
@@ -804,29 +708,28 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
"flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
"id": "clouddebugger.debugger.debuggees.breakpoints.set",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set"
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
+ "description": "Sets the breakpoint to the debuggee.",
+ "request": {
+ "$ref": "Breakpoint"
+ }
},
"delete": {
"response": {
"$ref": "Empty"
},
- "httpMethod": "DELETE",
"parameterOrder": [
"debuggeeId",
"breakpointId"
],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
"parameters": {
- "clientVersion": {
- "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
- },
"breakpointId": {
"location": "path",
"description": "ID of the breakpoint to delete.",
@@ -838,6 +741,44 @@
"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}",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
+ "description": "Deletes the breakpoint from the debuggee."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "response": {
+ "$ref": "GetBreakpointResponse"
+ },
+ "parameters": {
+ "clientVersion": {
+ "location": "query",
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string"
+ },
+ "breakpointId": {
+ "location": "path",
+ "description": "ID of the breakpoint to get.",
+ "required": true,
+ "type": "string"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoint to get.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -845,9 +786,68 @@
"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}",
- "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
- "description": "Deletes the breakpoint from the debuggee."
+ "description": "Gets breakpoint information."
+ },
+ "list": {
+ "description": "Lists all breakpoints for the debuggee.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBreakpointsResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "stripResults": {
+ "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoints to list.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "waitToken": {
+ "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.",
+ "type": "string",
+ "location": "query"
+ },
+ "action.value": {
+ "location": "query",
+ "enum": [
+ "CAPTURE",
+ "LOG"
+ ],
+ "description": "Only breakpoints with the specified action will pass the filter.",
+ "type": "string"
+ },
+ "clientVersion": {
+ "location": "query",
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string"
+ },
+ "includeAllUsers": {
+ "location": "query",
+ "description": "When set to `true`, the response includes the list of breakpoints set by\nany user. Otherwise, it includes only breakpoints set by the caller.",
+ "type": "boolean"
+ },
+ "includeInactive": {
+ "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.list",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints"
}
}
}
@@ -858,8 +858,88 @@
"controller": {
"resources": {
"debuggees": {
+ "resources": {
+ "breakpoints": {
+ "methods": {
+ "update": {
+ "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.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "debuggeeId",
+ "id"
+ ],
+ "response": {
+ "$ref": "UpdateActiveBreakpointResponse"
+ },
+ "parameters": {
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "debuggeeId": {
+ "location": "path",
+ "description": "Identifies the debuggee being debugged.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "id": "clouddebugger.controller.debuggees.breakpoints.update",
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListActiveBreakpointsResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "parameters": {
+ "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"
+ },
+ "debuggeeId": {
+ "description": "Identifies the debuggee.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "successOnTimeout": {
+ "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",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints",
+ "id": "clouddebugger.controller.debuggees.breakpoints.list",
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
+ "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (location, condition, and 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."
+ }
+ }
+ }
+ },
"methods": {
"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"
+ },
"response": {
"$ref": "RegisterDebuggeeResponse"
},
@@ -872,87 +952,7 @@
"parameters": {},
"flatPath": "v2/controller/debuggees/register",
"path": "v2/controller/debuggees/register",
- "id": "clouddebugger.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": {
- "update": {
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "id": "clouddebugger.controller.debuggees.breakpoints.update",
- "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller\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"
- },
- "response": {
- "$ref": "UpdateActiveBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId",
- "id"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "debuggeeId": {
- "location": "path",
- "description": "Identifies the debuggee being debugged.",
- "required": true,
- "type": "string"
- },
- "id": {
- "location": "path",
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}"
- },
- "list": {
- "response": {
- "$ref": "ListActiveBreakpointsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "debuggeeId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "debuggeeId": {
- "description": "Identifies the debuggee.",
- "required": true,
- "type": "string",
- "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"
- }
- },
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- "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."
- }
- }
+ "id": "clouddebugger.controller.debuggees.register"
}
}
}
@@ -960,6 +960,16 @@
}
},
"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",
@@ -972,40 +982,34 @@
"location": "query"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "callback": {
- "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"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -1013,18 +1017,24 @@
"media",
"proto"
],
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
},
"key": {
"description": "API key. Your API 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",
@@ -1035,25 +1045,15 @@
"type": "boolean",
"default": "true",
"location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
}
},
"version": "v2",
"baseUrl": "https://clouddebugger.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
"servicePath": "",
+ "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
+ "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20170413",
- "documentationLink": "http://cloud.google.com/debugger",
- "id": "clouddebugger:v2"
+ "id": "clouddebugger:v2",
+ "revision": "20170518",
+ "documentationLink": "http://cloud.google.com/debugger"
}
diff --git a/clouderrorreporting/v1beta1/clouderrorreporting-api.json b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
index 01072e7..04e55c8 100644
--- a/clouderrorreporting/v1beta1/clouderrorreporting-api.json
+++ b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
@@ -1,96 +1,19 @@
{
+ "kind": "discovery#restDescription",
+ "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20170530",
+ "documentationLink": "https://cloud.google.com/error-reporting/",
+ "id": "clouderrorreporting:v1beta1",
+ "discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "ReportErrorEventResponse": {
- "description": "Response for reporting an individual error event.\nData may be added to this message in the future.",
- "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": {
- "responseStatusCode": {
- "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"
- },
- "referrer": {
- "description": "The referrer information that is provided with the request.",
- "type": "string"
- },
- "userAgent": {
- "description": "The user agent information that is provided with the request.",
- "type": "string"
- },
- "url": {
- "description": "The URL of the request.",
- "type": "string"
- }
- },
- "id": "HttpRequestContext"
- },
- "ListGroupStatsResponse": {
- "description": "Contains a set of requested error group stats.",
- "type": "object",
- "properties": {
- "errorGroupStats": {
- "description": "The error group stats which match the given request.",
- "type": "array",
- "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"
- },
- "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",
- "type": "string"
- }
- },
- "id": "ListGroupStatsResponse"
- },
- "DeleteEventsResponse": {
- "id": "DeleteEventsResponse",
- "description": "Response message for deleting error events.",
- "type": "object",
- "properties": {}
- },
- "SourceReference": {
- "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.",
- "type": "object",
- "properties": {
- "repository": {
- "description": "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
- "type": "string"
- },
- "revisionId": {
- "description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
- "type": "string"
- }
- },
- "id": "SourceReference"
- },
"ErrorEvent": {
+ "id": "ErrorEvent",
"description": "An error event which is returned by the Error Reporting system.",
"type": "object",
"properties": {
- "message": {
- "description": "The stack trace that was reported or logged by the service.",
- "type": "string"
- },
"serviceContext": {
"$ref": "ServiceContext",
"description": "The `ServiceContext` for which this error was reported."
@@ -101,15 +24,16 @@
"type": "string"
},
"context": {
- "description": "Data about the context in which the error occurred.",
- "$ref": "ErrorContext"
+ "$ref": "ErrorContext",
+ "description": "Data about the context in which the error occurred."
+ },
+ "message": {
+ "description": "The stack trace that was reported or logged by the service.",
+ "type": "string"
}
- },
- "id": "ErrorEvent"
+ }
},
"ReportedErrorEvent": {
- "description": "An error event which is reported to the Error Reporting system.",
- "type": "object",
"properties": {
"eventTime": {
"description": "[Optional] Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.",
@@ -125,17 +49,23 @@
"type": "string"
},
"serviceContext": {
- "$ref": "ServiceContext",
- "description": "[Required] The service context in which this error has occurred."
+ "description": "[Required] The service context in which this error has occurred.",
+ "$ref": "ServiceContext"
}
},
- "id": "ReportedErrorEvent"
+ "id": "ReportedErrorEvent",
+ "description": "An error event which is reported to the Error Reporting system.",
+ "type": "object"
},
"ErrorContext": {
"id": "ErrorContext",
"description": "A description of the context in which an error occurred.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
"type": "object",
"properties": {
+ "user": {
+ "description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.",
+ "type": "string"
+ },
"reportLocation": {
"$ref": "SourceLocation",
"description": "The location in the source code where the decision was made to\nreport the error, usually the place where it was logged.\nFor a logged exception this would be the source line where the\nexception is logged, usually close to the place where it was\ncaught. This value is in contrast to `Exception.cause_location`,\nwhich describes the source line where the exception was thrown."
@@ -150,15 +80,10 @@
"httpRequest": {
"$ref": "HttpRequestContext",
"description": "The HTTP request which was processed when the error was\ntriggered."
- },
- "user": {
- "description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.",
- "type": "string"
}
}
},
"TrackingIssue": {
- "id": "TrackingIssue",
"description": "Information related to tracking the progress on resolving the error.",
"type": "object",
"properties": {
@@ -166,18 +91,13 @@
"description": "A URL pointing to a related entry in an issue tracking system.\nExample: https://github.com/user/project/issues/4",
"type": "string"
}
- }
+ },
+ "id": "TrackingIssue"
},
"ErrorGroupStats": {
- "id": "ErrorGroupStats",
"description": "Data extracted for a specific group based on certain filter criteria,\nsuch as a given time period and/or service filter.",
"type": "object",
"properties": {
- "numAffectedServices": {
- "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
- "format": "int32",
- "type": "integer"
- },
"affectedServices": {
"description": "Service contexts with a non-zero error count for the given filter\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count.",
"type": "array",
@@ -185,9 +105,14 @@
"$ref": "ServiceContext"
}
},
+ "numAffectedServices": {
+ "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
+ "format": "int32",
+ "type": "integer"
+ },
"representative": {
- "description": "An arbitrary event that is chosen as representative for the whole group.\nThe representative event is intended to be used as a quick preview for\nthe whole group. Events in the group are usually sufficiently similar\nto each other such that showing an arbitrary representative provides\ninsight into the characteristics of the group as a whole.",
- "$ref": "ErrorEvent"
+ "$ref": "ErrorEvent",
+ "description": "An arbitrary event that is chosen as representative for the whole group.\nThe representative event is intended to be used as a quick preview for\nthe whole group. Events in the group are usually sufficiently similar\nto each other such that showing an arbitrary representative provides\ninsight into the characteristics of the group as a whole."
},
"timedCounts": {
"description": "Approximate number of occurrences over time.\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requested time interval\n- Non-overlapping, and\n- Ordered by ascending time.",
@@ -197,8 +122,8 @@
}
},
"group": {
- "$ref": "ErrorGroup",
- "description": "Group data that is independent of the filter criteria."
+ "description": "Group data that is independent of the filter criteria.",
+ "$ref": "ErrorGroup"
},
"firstSeenTime": {
"description": "Approximate first occurrence that was ever seen for this group\nand which matches the given filter criteria, ignoring the\ntime_range that was specified in the request.",
@@ -220,16 +145,16 @@
"format": "google-datetime",
"type": "string"
}
- }
+ },
+ "id": "ErrorGroupStats"
},
"ListEventsResponse": {
- "description": "Contains a set of requested error events.",
"type": "object",
"properties": {
"timeRangeBegin": {
+ "type": "string",
"description": "The timestamp specifies the start time to which the request was restricted.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"errorEvents": {
"description": "The error events which match the given request.",
@@ -243,7 +168,8 @@
"type": "string"
}
},
- "id": "ListEventsResponse"
+ "id": "ListEventsResponse",
+ "description": "Contains a set of requested error events."
},
"TimedCount": {
"id": "TimedCount",
@@ -256,9 +182,9 @@
"type": "string"
},
"count": {
+ "type": "string",
"description": "Approximate number of occurrences in the given time period.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
},
"startTime": {
"description": "Start of the time period to which `count` refers (included).",
@@ -268,10 +194,13 @@
}
},
"ErrorGroup": {
- "id": "ErrorGroup",
"description": "Description of a group of similar error events.",
"type": "object",
"properties": {
+ "name": {
+ "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
+ "type": "string"
+ },
"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.",
"type": "string"
@@ -282,21 +211,14 @@
"items": {
"$ref": "TrackingIssue"
}
- },
- "name": {
- "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
- "type": "string"
}
- }
+ },
+ "id": "ErrorGroup"
},
"ServiceContext": {
"description": "Describes a running service that sends errors.\nIts version changes over time and multiple versions can run in parallel.",
"type": "object",
"properties": {
- "version": {
- "description": "Represents the source code version that the developer provided,\nwhich could represent a version label or a Git SHA-1 hash, for example.\nFor App Engine standard environment, the version is set to the version of\nthe app.",
- "type": "string"
- },
"service": {
"description": "An identifier of the service, such as the name of the\nexecutable, job, or Google App Engine service name. This field is expected\nto have a low number of values that are relatively stable over time, as\nopposed to `version`, which can be changed whenever new code is deployed.\n\nContains the service name for error reports extracted from Google\nApp Engine logs or `default` if the App Engine default service is used.",
"type": "string"
@@ -304,15 +226,21 @@
"resourceType": {
"description": "Type of the MonitoredResource. List of possible values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set automatically for incoming errors and must not be set when\nreporting errors.",
"type": "string"
+ },
+ "version": {
+ "description": "Represents the source code version that the developer provided,\nwhich could represent a version label or a Git SHA-1 hash, for example.\nFor App Engine standard environment, the version is set to the version of\nthe app.",
+ "type": "string"
}
},
"id": "ServiceContext"
},
"SourceLocation": {
- "id": "SourceLocation",
- "description": "Indicates a location in the source code of the service for which errors are\nreported. `functionName` must be provided by the application when reporting\nan error, unless the error report contains a `message` with a supported\nexception stack trace. All fields are optional for the later case.",
"type": "object",
"properties": {
+ "functionName": {
+ "type": "string",
+ "description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java."
+ },
"filePath": {
"description": "The source code filename, which can include a truncated relative\npath, or a full path from a production machine.",
"type": "string"
@@ -321,18 +249,98 @@
"description": "1-based. 0 indicates that the line number is unknown.",
"format": "int32",
"type": "integer"
+ }
+ },
+ "id": "SourceLocation",
+ "description": "Indicates a location in the source code of the service for which errors are\nreported. `functionName` must be provided by the application when reporting\nan error, unless the error report contains a `message` with a supported\nexception stack trace. All fields are optional for the later case."
+ },
+ "ReportErrorEventResponse": {
+ "description": "Response for reporting an individual error event.\nData may be added to this message in the future.",
+ "type": "object",
+ "properties": {},
+ "id": "ReportErrorEventResponse"
+ },
+ "HttpRequestContext": {
+ "id": "HttpRequestContext",
+ "description": "HTTP request data that is related to a reported error.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
+ "type": "object",
+ "properties": {
+ "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"
},
- "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.",
+ "referrer": {
+ "description": "The referrer information that is provided with the request.",
+ "type": "string"
+ },
+ "userAgent": {
+ "description": "The user agent information that is provided with the request.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL of the request.",
+ "type": "string"
+ },
+ "responseStatusCode": {
+ "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"
}
}
+ },
+ "ListGroupStatsResponse": {
+ "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",
+ "type": "string"
+ },
+ "errorGroupStats": {
+ "description": "The error group stats which match the given request.",
+ "type": "array",
+ "items": {
+ "$ref": "ErrorGroupStats"
+ }
+ }
+ },
+ "id": "ListGroupStatsResponse"
+ },
+ "SourceReference": {
+ "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.",
+ "type": "object",
+ "properties": {
+ "repository": {
+ "description": "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
+ "type": "string"
+ }
+ },
+ "id": "SourceReference"
+ },
+ "DeleteEventsResponse": {
+ "id": "DeleteEventsResponse",
+ "description": "Response message for deleting error events.",
+ "type": "object",
+ "properties": {}
}
},
"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": "Clouderrorreporting",
"auth": {
@@ -354,6 +362,19 @@
"projects": {
"methods": {
"deleteEvents": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectName": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/events",
"path": "v1beta1/{+projectName}/events",
"id": "clouderrorreporting.projects.deleteEvents",
"description": "Deletes all error events of a given project.",
@@ -363,36 +384,13 @@
"parameterOrder": [
"projectName"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectName": {
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/events"
+ "httpMethod": "DELETE"
}
},
"resources": {
"groups": {
"methods": {
"get": {
- "path": "v1beta1/{+groupName}",
- "id": "clouderrorreporting.projects.groups.get",
- "description": "Get the specified group.",
- "response": {
- "$ref": "ErrorGroup"
- },
- "parameterOrder": [
- "groupName"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -405,35 +403,45 @@
"location": "path"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}"
- },
- "update": {
- "path": "v1beta1/{+name}",
- "id": "clouderrorreporting.projects.groups.update",
- "description": "Replace the data for the specified group.\nFails if the group does not exist.",
- "request": {
- "$ref": "ErrorGroup"
- },
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
+ "path": "v1beta1/{+groupName}",
+ "id": "clouderrorreporting.projects.groups.get",
+ "description": "Get the specified group.",
"response": {
"$ref": "ErrorGroup"
},
"parameterOrder": [
+ "groupName"
+ ],
+ "httpMethod": "GET"
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
"name"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "ErrorGroup"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/groups/[^/]+$",
"location": "path",
"description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}"
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
+ "id": "clouderrorreporting.projects.groups.update",
+ "path": "v1beta1/{+name}",
+ "description": "Replace the data for the specified group.\nFails if the group does not exist.",
+ "request": {
+ "$ref": "ErrorGroup"
+ }
}
}
},
@@ -448,29 +456,10 @@
"projectName"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "projectName": {
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "timedCountDuration": {
- "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
- "format": "google-duration",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
- "type": "string"
- },
"timeRange.period": {
+ "description": "Restricts the query to the specified time range.",
+ "type": "string",
"location": "query",
"enum": [
"PERIOD_UNSPECIFIED",
@@ -479,9 +468,7 @@
"PERIOD_1_DAY",
"PERIOD_1_WEEK",
"PERIOD_30_DAYS"
- ],
- "description": "Restricts the query to the specified time range.",
- "type": "string"
+ ]
},
"alignment": {
"description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
@@ -500,17 +487,18 @@
"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",
- "location": "query"
+ "type": "string"
},
"pageSize": {
+ "location": "query",
"description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"order": {
+ "type": "string",
"location": "query",
"enum": [
"GROUP_ORDER_UNSPECIFIED",
@@ -519,8 +507,7 @@
"CREATED_DESC",
"AFFECTED_USERS_DESC"
],
- "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
- "type": "string"
+ "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`."
},
"serviceFilter.version": {
"location": "query",
@@ -528,17 +515,38 @@
"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",
- "location": "query"
+ "type": "string"
},
"alignmentTime": {
"location": "query",
"description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.",
"format": "google-datetime",
"type": "string"
+ },
+ "projectName": {
+ "location": "path",
+ "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/[^/]+$"
+ },
+ "timedCountDuration": {
+ "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
+ "format": "google-duration",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta1/projects/{projectsId}/groupStats",
"path": "v1beta1/{+projectName}/groupStats",
"id": "clouderrorreporting.projects.groupStats.list"
@@ -548,49 +556,28 @@
"events": {
"methods": {
"list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "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": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "required": true,
- "type": "string"
- },
"groupId": {
"description": "[Required] The group for which events shall be returned.",
"type": "string",
"location": "query"
},
- "pageToken": {
- "description": "[Optional] A `next_page_token` provided by a previous response.",
- "type": "string",
- "location": "query"
- },
"serviceFilter.service": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service)."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "[Optional] A `next_page_token` provided by a previous response.",
+ "type": "string"
},
"pageSize": {
"description": "[Optional] The maximum number of results to return per response.",
@@ -599,26 +586,45 @@
"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",
+ "location": "query"
+ },
+ "serviceFilter.resourceType": {
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
"type": "string"
+ },
+ "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",
"path": "v1beta1/{+projectName}/events",
"id": "clouderrorreporting.projects.events.list",
- "description": "Lists the specified events.",
- "response": {
- "$ref": "ListEventsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "GET"
+ "description": "Lists the specified events."
},
"report": {
- "path": "v1beta1/{+projectName}/events:report",
- "id": "clouderrorreporting.projects.events.report",
"request": {
"$ref": "ReportedErrorEvent"
},
@@ -632,17 +638,19 @@
"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"
+ "type": "string"
}
},
"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"
}
}
}
@@ -651,9 +659,9 @@
},
"parameters": {
"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",
@@ -671,14 +679,7 @@
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -687,14 +688,16 @@
"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",
@@ -703,7 +706,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"access_token": {
"description": "OAuth access token.",
@@ -711,9 +719,9 @@
"location": "query"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -726,25 +734,17 @@
"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"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"version": "v1beta1",
- "baseUrl": "https://clouderrorreporting.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n",
- "servicePath": "",
- "basePath": "",
- "revision": "20170501",
- "documentationLink": "https://cloud.google.com/error-reporting/",
- "id": "clouderrorreporting:v1beta1",
- "discoveryVersion": "v1"
+ "baseUrl": "https://clouderrorreporting.googleapis.com/"
}
diff --git a/cloudfunctions/v1/cloudfunctions-api.json b/cloudfunctions/v1/cloudfunctions-api.json
index 6744e2e..e8def1a 100644
--- a/cloudfunctions/v1/cloudfunctions-api.json
+++ b/cloudfunctions/v1/cloudfunctions-api.json
@@ -1,49 +1,95 @@
{
- "discoveryVersion": "v1",
+ "baseUrl": "https://cloudfunctions.googleapis.com/",
+ "canonicalName": "Cloud Functions",
+ "servicePath": "",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://cloudfunctions.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "cloudfunctions",
+ "batchPath": "batch",
+ "revision": "20170529",
+ "id": "cloudfunctions:v1",
+ "documentationLink": "https://cloud.google.com/functions",
+ "title": "Google Cloud Functions API",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": "True",
"resources": {},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
- "prettyPrint": {
+ "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": {
+ "type": "string",
"location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "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"
+ "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"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "$.xgafv": {
"type": "string",
- "location": "query"
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
},
"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": {
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -56,39 +102,7 @@
"json",
"media",
"proto"
- ],
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ ]
}
},
"schemas": {
@@ -128,24 +142,10 @@
"id": "OperationMetadataV1Beta2"
}
},
+ "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://cloudfunctions.googleapis.com/",
- "canonicalName": "Cloud Functions",
- "kind": "discovery#restDescription",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
- "servicePath": "",
- "rootUrl": "https://cloudfunctions.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "cloudfunctions",
- "batchPath": "batch",
- "revision": "20170509",
- "documentationLink": "https://cloud.google.com/functions",
- "id": "cloudfunctions:v1",
- "title": "Google Cloud Functions API"
+ "version": "v1"
}
diff --git a/cloudfunctions/v1beta2/cloudfunctions-api.json b/cloudfunctions/v1beta2/cloudfunctions-api.json
index d591dd8..1fa1de7 100644
--- a/cloudfunctions/v1beta2/cloudfunctions-api.json
+++ b/cloudfunctions/v1beta2/cloudfunctions-api.json
@@ -12,12 +12,15 @@
"list": {
"description": "Lists information about the supported locations for this service.",
"httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "ListLocationsResponse"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"pageSize": {
"location": "query",
@@ -31,11 +34,11 @@
"location": "query"
},
"name": {
- "location": "path",
"description": "The resource that owns the locations collection, if applicable.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$"
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
},
"pageToken": {
"location": "query",
@@ -43,9 +46,6 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta2/projects/{projectsId}/locations",
"id": "cloudfunctions.projects.locations.list",
"path": "v1beta2/{+name}/locations"
@@ -54,156 +54,7 @@
"resources": {
"functions": {
"methods": {
- "delete": {
- "id": "cloudfunctions.projects.locations.functions.delete",
- "path": "v1beta2/{+name}",
- "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function which should be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}"
- },
- "list": {
- "description": "Returns a list of functions that belong to the requested project.",
- "response": {
- "$ref": "ListFunctionsResponse"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "location": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of functions to return per call.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
- "path": "v1beta2/{+location}/functions",
- "id": "cloudfunctions.projects.locations.functions.list"
- },
- "call": {
- "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
- "request": {
- "$ref": "CallFunctionRequest"
- },
- "response": {
- "$ref": "CallFunctionResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the function to be called.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
- "path": "v1beta2/{+name}:call",
- "id": "cloudfunctions.projects.locations.functions.call"
- },
- "create": {
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
- "id": "cloudfunctions.projects.locations.functions.create",
- "path": "v1beta2/{+location}/functions",
- "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
- "request": {
- "$ref": "CloudFunction"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "location"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "location": {
- "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- }
- },
- "get": {
- "description": "Returns a function with the given name from the requested project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CloudFunction"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the function which details should be obtained.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "id": "cloudfunctions.projects.locations.functions.get",
- "path": "v1beta2/{+name}"
- },
"update": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
"parameters": {
"name": {
"location": "path",
@@ -222,7 +73,156 @@
"request": {
"$ref": "CloudFunction"
},
- "description": "Updates existing function."
+ "description": "Updates existing function.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function which should be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "id": "cloudfunctions.projects.locations.functions.delete",
+ "path": "v1beta2/{+name}",
+ "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function."
+ },
+ "list": {
+ "description": "Returns a list of functions that belong to the requested project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "location"
+ ],
+ "response": {
+ "$ref": "ListFunctionsResponse"
+ },
+ "parameters": {
+ "location": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Maximum number of functions to return per call.",
+ "format": "int32"
+ }
+ },
+ "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"
+ },
+ "call": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CallFunctionResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the function to be called.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
+ "id": "cloudfunctions.projects.locations.functions.call",
+ "path": "v1beta2/{+name}:call",
+ "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
+ "request": {
+ "$ref": "CallFunctionRequest"
+ }
+ },
+ "create": {
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "location"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "location": {
+ "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "id": "cloudfunctions.projects.locations.functions.create",
+ "path": "v1beta2/{+location}/functions"
+ },
+ "get": {
+ "description": "Returns a function with the given name from the requested project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "CloudFunction"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function which details should be obtained.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "id": "cloudfunctions.projects.locations.functions.get",
+ "path": "v1beta2/{+name}"
}
}
}
@@ -233,47 +233,43 @@
"operations": {
"methods": {
"list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
"name": {
+ "type": "string",
"location": "query",
- "description": "The name of the operation collection.",
- "type": "string"
+ "description": "The name of the operation's parent resource."
},
"pageToken": {
- "location": "query",
"description": "The standard list page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
"description": "The standard list page size.",
"format": "int32",
"type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta2/operations",
"path": "v1beta2/operations",
- "id": "cloudfunctions.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`."
+ "id": "cloudfunctions.operations.list"
},
"get": {
- "flatPath": "v1beta2/operations/{operationsId}",
- "path": "v1beta2/{+name}",
- "id": "cloudfunctions.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"response": {
"$ref": "Operation"
},
@@ -292,53 +288,57 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1beta2/operations/{operationsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
}
}
}
},
"parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "default": "true"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
- "type": "string",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
},
"fields": {
- "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
@@ -353,12 +353,9 @@
"2"
]
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
+ "location": "query",
+ "description": "Data format for response.",
"default": "json",
"enum": [
"json",
@@ -370,125 +367,58 @@
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response."
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
- "access_token": {
- "type": "string",
+ "quotaUser": {
"location": "query",
- "description": "OAuth access 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"
}
},
"version": "v1beta2",
"baseUrl": "https://cloudfunctions.googleapis.com/",
- "servicePath": "",
"kind": "discovery#restDescription",
"description": "API for managing lightweight user-provided functions executed in response to events.",
+ "servicePath": "",
"basePath": "",
- "id": "cloudfunctions:v1beta2",
+ "revision": "20170529",
"documentationLink": "https://cloud.google.com/functions",
- "revision": "20170509",
+ "id": "cloudfunctions:v1beta2",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "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": {
- "type": "string",
- "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."
- }
- }
- },
- "CallFunctionResponse": {
- "type": "object",
- "properties": {
- "executionId": {
- "type": "string",
- "description": "Execution id of function invocation."
- },
- "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."
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListLocationsResponse"
- },
- "EventTrigger": {
- "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
- "type": "object",
- "properties": {
- "eventType": {
- "type": "string",
- "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`"
- },
- "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"
- }
- },
- "id": "EventTrigger"
- },
"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"
+ "type": "string",
+ "description": "Output only. The deployed url for the function."
}
- },
- "id": "HTTPSTrigger"
+ }
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "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`.",
@@ -499,12 +429,12 @@
"$ref": "Status"
},
"metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
},
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
@@ -518,16 +448,16 @@
"type": "object",
"properties": {
"target": {
- "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
- "type": "string"
+ "type": "string",
+ "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1"
},
"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."
- }
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The original request that started the operation.",
+ "type": "object"
},
"type": {
"description": "Type of operation.",
@@ -549,8 +479,6 @@
"id": "OperationMetadataV1Beta2"
},
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` 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.\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.",
@@ -569,14 +497,15 @@
"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"
+ "type": "string",
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
}
},
- "id": "Status"
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
},
"CallFunctionRequest": {
- "id": "CallFunctionRequest",
"description": "Request for the `CallFunction` method.",
"type": "object",
"properties": {
@@ -584,12 +513,19 @@
"description": "Input to be passed to the function.",
"type": "string"
}
- }
+ },
+ "id": "CallFunctionRequest"
},
"SourceRepository": {
- "description": "Describes the location of the function source in a remote repository.",
- "type": "object",
"properties": {
+ "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"
+ },
"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"
@@ -605,23 +541,64 @@
"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"
}
},
- "id": "SourceRepository"
+ "id": "SourceRepository",
+ "description": "Describes the location of the function source in a remote repository.",
+ "type": "object"
},
"CloudFunction": {
- "id": "CloudFunction",
"description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
"type": "object",
"properties": {
+ "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": {
+ "type": "string",
+ "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"
+ },
+ "eventTrigger": {
+ "$ref": "EventTrigger",
+ "description": "A source that fires events in response to a condition in another service."
+ },
+ "availableMemoryMb": {
+ "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
+ "type": "string"
+ },
+ "serviceAccount": {
+ "description": "Output only. The service account of the function.",
+ "type": "string"
+ },
+ "sourceArchiveUrl": {
+ "type": "string",
+ "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function."
+ },
+ "sourceRepository": {
+ "description": "The hosted repository where the function is defined.",
+ "$ref": "SourceRepository"
+ },
"entryPoint": {
"description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
"type": "string"
@@ -638,68 +615,14 @@
"httpsTrigger": {
"$ref": "HTTPSTrigger",
"description": "An HTTPS endpoint type of source that can be triggered via URL."
- },
- "eventTrigger": {
- "$ref": "EventTrigger",
- "description": "A source that fires events in response to a condition in another service."
- },
- "status": {
- "description": "Output only. Status of the function deployment.",
- "type": "string",
- "enumDescriptions": [
- "Status not specified.",
- "Successfully deployed.",
- "Not deployed correctly - behavior is undefined. The item should be updated\nor deleted to move it out of this state.",
- "Creation or update in progress.",
- "Deletion in progress."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "READY",
- "FAILED",
- "DEPLOYING",
- "DELETING"
- ]
- },
- "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": {
- "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
- "type": "string"
- },
- "serviceAccount": {
- "type": "string",
- "description": "Output only. The service account of the function."
- },
- "sourceArchiveUrl": {
- "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.",
- "type": "string"
- },
- "sourceRepository": {
- "description": "The hosted repository where the function is defined.",
- "$ref": "SourceRepository"
}
- }
+ },
+ "id": "CloudFunction"
},
"Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
- "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.",
@@ -709,15 +632,22 @@
"type": "object"
},
"labels": {
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
+ },
+ "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"
}
},
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location."
+ "id": "Location"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -728,21 +658,91 @@
"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"
+ },
+ "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"
+ }
+ },
+ "id": "ListFunctionsResponse"
+ },
+ "CallFunctionResponse": {
+ "properties": {
+ "result": {
+ "type": "string",
+ "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context."
+ },
+ "error": {
+ "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
+ "type": "string"
+ },
+ "executionId": {
+ "description": "Execution id of function invocation.",
+ "type": "string"
+ }
+ },
+ "id": "CallFunctionResponse",
+ "description": "Response of `CallFunction` method.",
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ },
+ "description": "A list of locations that matches the specified filter in the request."
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "EventTrigger": {
+ "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
+ "type": "object",
+ "properties": {
+ "eventType": {
+ "description": "`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`\n\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"
+ },
+ "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"
+ }
+ },
+ "id": "EventTrigger"
}
},
+ "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
"canonicalName": "Cloud Functions",
"auth": {
"oauth2": {
diff --git a/cloudfunctions/v1beta2/cloudfunctions-gen.go b/cloudfunctions/v1beta2/cloudfunctions-gen.go
index 9542ea9..a1512a2 100644
--- a/cloudfunctions/v1beta2/cloudfunctions-gen.go
+++ b/cloudfunctions/v1beta2/cloudfunctions-gen.go
@@ -749,7 +749,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -998,9 +998,18 @@
// server doesn't support this method, it returns
// `UNIMPLEMENTED`.
//
-// NOTE: the `name` binding below allows API services to override the
+// NOTE: the `name` binding allows API services to override the
// binding
// to use different resource name schemes, such as `users/*/operations`.
+// To
+// override the binding, API services can add a binding such
+// as
+// "/v1/{name=users/*}/operations" to their service configuration.
+// For backwards compatibility, the default name includes the
+// operations
+// collection id, however overriding users must ensure the name
+// binding
+// is the parent resource, without the operations collection id.
func (r *OperationsService) List() *OperationsListCall {
c := &OperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
return c
@@ -1013,8 +1022,8 @@
return c
}
-// Name sets the optional parameter "name": The name of the operation
-// collection.
+// Name sets the optional parameter "name": The name of the operation's
+// parent resource.
func (c *OperationsListCall) Name(name string) *OperationsListCall {
c.urlParams_.Set("name", name)
return c
@@ -1125,7 +1134,7 @@
}
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`.",
+ // "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
// "flatPath": "v1beta2/operations",
// "httpMethod": "GET",
// "id": "cloudfunctions.operations.list",
@@ -1137,7 +1146,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "query",
// "type": "string"
// },
diff --git a/cloudkms/v1/cloudkms-api.json b/cloudkms/v1/cloudkms-api.json
index 3cb4664..a57a8e3 100644
--- a/cloudkms/v1/cloudkms-api.json
+++ b/cloudkms/v1/cloudkms-api.json
@@ -2,6 +2,22 @@
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "SetIamPolicyRequest": {
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "SetIamPolicyRequest",
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object"
+ },
"DecryptRequest": {
"description": "Request message for KeyManagementService.Decrypt.",
"type": "object",
@@ -20,18 +36,9 @@
"id": "DecryptRequest"
},
"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"
@@ -43,11 +50,20 @@
},
"description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
+ },
+ "labels": {
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
}
},
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
+ "id": "Location"
},
"ListCryptoKeysResponse": {
"description": "Response message for KeyManagementService.ListCryptoKeys.",
@@ -76,6 +92,28 @@
"description": "A condition to be met.",
"type": "object",
"properties": {
+ "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"
+ },
"values": {
"description": "The objects of the condition. This is mutually exclusive with 'value'.",
"type": "array",
@@ -90,7 +128,7 @@
"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.",
+ "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).",
"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": [
@@ -124,28 +162,6 @@
"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"
}
},
"id": "Condition"
@@ -169,16 +185,7 @@
"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",
@@ -190,7 +197,16 @@
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
- ]
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
+ },
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "AuditLogConfig"
@@ -208,6 +224,8 @@
"id": "DecryptResponse"
},
"TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
@@ -217,13 +235,27 @@
}
}
},
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
+ "id": "TestIamPermissionsRequest"
+ },
+ "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": {
- "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
- "type": "object",
"properties": {
"createTime": {
"description": "Output only. The time at which this KeyRing was created.",
@@ -235,42 +267,26 @@
"type": "string"
}
},
- "id": "KeyRing"
+ "id": "KeyRing",
+ "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
+ "type": "object"
},
"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"
+ },
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion used in encryption.",
+ "type": "string"
}
},
"id": "EncryptResponse"
},
- "ListLocationsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- }
- },
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
- },
"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",
@@ -288,7 +304,7 @@
}
},
"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.",
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"type": "array",
"items": {
"$ref": "Binding"
@@ -359,8 +375,6 @@
"id": "ListKeyRingsResponse"
},
"AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.\nNext ID: 4",
@@ -380,12 +394,39 @@
"type": "string"
}
},
- "id": "AuditConfig"
+ "id": "AuditConfig",
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object"
},
"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": {
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKeyVersion was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "Not specified.",
+ "This version may be used in Encrypt and\nDecrypt requests.",
+ "This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
+ "This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
+ "This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
+ ],
+ "enum": [
+ "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
+ "ENABLED",
+ "DISABLED",
+ "DESTROYED",
+ "DESTROY_SCHEDULED"
+ ],
+ "description": "The current state of the CryptoKeyVersion.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "type": "string"
+ },
"destroyEventTime": {
"description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
"format": "google-datetime",
@@ -395,47 +436,39 @@
"description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
"format": "google-datetime",
"type": "string"
- },
- "createTime": {
- "description": "Output only. The time at which this CryptoKeyVersion was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "state": {
- "enum": [
- "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
- "ENABLED",
- "DISABLED",
- "DESTROYED",
- "DESTROY_SCHEDULED"
- ],
- "description": "The current state of the CryptoKeyVersion.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "This version may be used in Encrypt and\nDecrypt requests.",
- "This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
- "This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
- "This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
- ]
- },
- "name": {
- "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
- "type": "string"
}
},
- "id": "CryptoKeyVersion"
+ "id": "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"
},
"CloudAuditOptions": {
"description": "Write a Cloud Audit log",
"type": "object",
- "properties": {},
+ "properties": {
+ "logName": {
+ "description": "The log_name to populate in the Cloud Audit Record.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default. Should not be used.",
+ "Corresponds to \"cloudaudit.googleapis.com/activity\"",
+ "Corresponds to \"cloudaudit.googleapis.com/data_access\""
+ ],
+ "enum": [
+ "UNSPECIFIED_LOG_NAME",
+ "ADMIN_ACTIVITY",
+ "DATA_ACCESS"
+ ]
+ }
+ },
"id": "CloudAuditOptions"
},
"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",
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"type": "array",
"items": {
"type": "string"
@@ -444,11 +477,36 @@
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
+ },
+ "condition": {
+ "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.",
+ "$ref": "Expr"
}
},
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
+ "id": "Binding"
+ },
+ "Expr": {
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
+ "type": "string"
+ },
+ "location": {
+ "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "Textual representation of an expression in\n[Common Expression Language](http://go/api-expr) syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
+ "type": "string"
+ }
+ },
+ "id": "Expr"
},
"EncryptRequest": {
"description": "Request message for KeyManagementService.Encrypt.",
@@ -491,8 +549,6 @@
"type": "object"
},
"TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -502,7 +558,9 @@
}
}
},
- "id": "TestIamPermissionsResponse"
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
},
"DestroyCryptoKeyVersionRequest": {
"description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
@@ -514,24 +572,6 @@
"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",
@@ -572,6 +612,24 @@
],
"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"
+ }
+ },
+ "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"
@@ -580,6 +638,23 @@
"description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
"type": "object",
"properties": {
+ "purpose": {
+ "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
+ ],
+ "enum": [
+ "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
+ "ENCRYPT_DECRYPT"
+ ]
+ },
+ "nextRotationTime": {
+ "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"createTime": {
"description": "Output only. The time at which this CryptoKey was created.",
"format": "google-datetime",
@@ -597,60 +672,27 @@
"name": {
"description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
"type": "string"
- },
- "purpose": {
- "enumDescriptions": [
- "Not specified.",
- "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
- ],
- "enum": [
- "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
- "ENCRYPT_DECRYPT"
- ],
- "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
- "type": "string"
- },
- "nextRotationTime": {
- "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "CryptoKey"
},
"LogConfig": {
- "description": "Specifies what kind of log the caller must write",
- "type": "object",
"properties": {
+ "counter": {
+ "description": "Counter options.",
+ "$ref": "CounterOptions"
+ },
"dataAccess": {
- "description": "Data access options.",
- "$ref": "DataAccessOptions"
+ "$ref": "DataAccessOptions",
+ "description": "Data access options."
},
"cloudAudit": {
"$ref": "CloudAuditOptions",
"description": "Cloud audit options."
- },
- "counter": {
- "description": "Counter options.",
- "$ref": "CounterOptions"
}
},
- "id": "LogConfig"
- },
- "SetIamPolicyRequest": {
- "properties": {
- "updateMask": {
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
- }
- },
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
+ "id": "LogConfig",
+ "description": "Specifies what kind of log the caller must write",
"type": "object"
}
},
@@ -679,328 +721,24 @@
"projects": {
"resources": {
"locations": {
- "methods": {
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations",
- "id": "cloudkms.projects.locations.list",
- "path": "v1/{+name}/locations"
- },
- "get": {
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Resource name for the location.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.get"
- }
- },
"resources": {
"keyRings": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListKeyRingsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "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": {
- "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"
- },
- "pageToken": {
- "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
- "id": "cloudkms.projects.locations.keyRings.list",
- "path": "v1/{+parent}/keyRings",
- "description": "Lists KeyRings."
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.setIamPolicy"
- },
- "create": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
- "path": "v1/{+parent}/keyRings",
- "id": "cloudkms.projects.locations.keyRings.create",
- "request": {
- "$ref": "KeyRing"
- },
- "description": "Create a new KeyRing in a given Project and Location.",
- "response": {
- "$ref": "KeyRing"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "keyRingId": {
- "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "response": {
- "$ref": "KeyRing"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the KeyRing to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.get",
- "description": "Returns metadata for a given KeyRing."
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.testIamPermissions"
- }
- },
"resources": {
"cryptoKeys": {
"methods": {
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.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"
- }
- },
- "decrypt": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "DecryptResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
- "path": "v1/{+name}:decrypt",
- "description": "Decrypt data that was protected by Encrypt.",
- "request": {
- "$ref": "DecryptRequest"
- }
- },
"list": {
- "httpMethod": "GET",
"response": {
"$ref": "ListCryptoKeysResponse"
},
"parameterOrder": [
"parent"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "GET",
"parameters": {
"pageToken": {
+ "location": "query",
"description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -1016,15 +754,16 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
"path": "v1/{+parent}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
"description": "Lists CryptoKeys."
},
"encrypt": {
- "path": "v1/{+name}:encrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
- "description": "Encrypt data, so that it can only be recovered by a call to Decrypt.",
+ "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
"request": {
"$ref": "EncryptRequest"
},
@@ -1040,42 +779,16 @@
],
"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",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt"
- },
- "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/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
+ "path": "v1/{+name}:encrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt"
},
"create": {
"request": {
@@ -1096,11 +809,11 @@
"location": "query"
},
"parent": {
+ "location": "path",
"description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
}
},
"scopes": [
@@ -1110,14 +823,42 @@
"path": "v1/{+parent}/cryptoKeys",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.create"
},
- "updatePrimaryVersion": {
- "httpMethod": "POST",
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "response": {
+ "$ref": "Policy"
+ },
"parameterOrder": [
- "name"
+ "resource"
],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy"
+ },
+ "updatePrimaryVersion": {
"response": {
"$ref": "CryptoKey"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -1131,24 +872,25 @@
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
"path": "v1/{+name}:updatePrimaryVersion",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
"description": "Update the version of a CryptoKey that will be used in Encrypt",
"request": {
"$ref": "UpdateCryptoKeyPrimaryVersionRequest"
}
},
"getIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}: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"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Policy"
+ },
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
@@ -1158,12 +900,17 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}: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."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"patch": {
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
+ "path": "v1/{+name}",
+ "description": "Update a CryptoKey.",
+ "request": {
+ "$ref": "CryptoKey"
+ },
"httpMethod": "PATCH",
"parameterOrder": [
"name"
@@ -1171,6 +918,9 @@
"response": {
"$ref": "CryptoKey"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"updateMask": {
"description": "Required list of fields to be updated in this request.",
@@ -1179,26 +929,16 @@
"location": "query"
},
"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",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
+ "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.patch",
- "path": "v1/{+name}",
- "request": {
- "$ref": "CryptoKey"
- },
- "description": "Update a CryptoKey."
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}"
},
"get": {
- "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
"response": {
"$ref": "CryptoKey"
},
@@ -1220,21 +960,86 @@
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
"path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get"
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
+ "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion."
+ },
+ "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": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions"
+ },
+ "decrypt": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
+ "path": "v1/{+name}:decrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
+ "request": {
+ "$ref": "DecryptRequest"
+ },
+ "description": "Decrypts data that was protected by Encrypt.",
+ "response": {
+ "$ref": "DecryptResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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"
+ ]
}
},
"resources": {
"cryptoKeyVersions": {
"methods": {
"list": {
+ "description": "Lists CryptoKeyVersions.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListCryptoKeyVersionsResponse"
},
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
"parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
+ },
"pageToken": {
"location": "query",
"description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
@@ -1245,31 +1050,16 @@
"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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "path": "v1/{+parent}/cryptoKeyVersions",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
- "description": "Lists CryptoKeyVersions."
+ "path": "v1/{+parent}/cryptoKeyVersions"
},
"destroy": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
- "path": "v1/{+name}:destroy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
- "request": {
- "$ref": "DestroyCryptoKeyVersionRequest"
- },
- "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
"response": {
"$ref": "CryptoKeyVersion"
},
@@ -1279,22 +1069,29 @@
"httpMethod": "POST",
"parameters": {
"name": {
+ "location": "path",
"description": "The resource name of the CryptoKeyVersion to destroy.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
+ "path": "v1/{+name}:destroy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
+ "request": {
+ "$ref": "DestroyCryptoKeyVersionRequest"
+ },
+ "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process."
},
"create": {
- "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
"request": {
"$ref": "CryptoKeyVersion"
},
+ "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"
},
@@ -1302,9 +1099,6 @@
"parent"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"parent": {
"location": "path",
@@ -1314,11 +1108,18 @@
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
"path": "v1/{+parent}/cryptoKeyVersions",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create"
},
"restore": {
+ "request": {
+ "$ref": "RestoreCryptoKeyVersionRequest"
+ },
+ "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
"response": {
"$ref": "CryptoKeyVersion"
},
@@ -1326,6 +1127,30 @@
"name"
],
"httpMethod": "POST",
+ "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": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
+ "path": "v1/{+name}:restore",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -1333,49 +1158,24 @@
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
"location": "path",
- "description": "The resource name of the CryptoKeyVersion to restore.",
+ "description": "The name of the CryptoKeyVersion to get.",
"required": true,
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
- "path": "v1/{+name}:restore",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
- "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
- "request": {
- "$ref": "RestoreCryptoKeyVersionRequest"
- }
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "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": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
"path": "v1/{+name}",
"description": "Returns metadata for a given CryptoKeyVersion."
},
"patch": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
+ "path": "v1/{+name}",
+ "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"
},
- "description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.",
"httpMethod": "PATCH",
"parameterOrder": [
"name"
@@ -1383,40 +1183,324 @@
"response": {
"$ref": "CryptoKeyVersion"
},
- "parameters": {
- "name": {
- "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
- },
- "updateMask": {
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
- "path": "v1/{+name}"
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "location": "path",
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
+ }
+ }
}
}
}
}
}
+ },
+ "methods": {
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ },
+ "list": {
+ "description": "Lists KeyRings.",
+ "response": {
+ "$ref": "ListKeyRingsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ "path": "v1/{+parent}/keyRings",
+ "id": "cloudkms.projects.locations.keyRings.list"
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ "id": "cloudkms.projects.locations.keyRings.create",
+ "path": "v1/{+parent}/keyRings",
+ "request": {
+ "$ref": "KeyRing"
+ },
+ "description": "Create a new KeyRing in a given Project and Location.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "parameters": {
+ "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"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy"
+ },
+ "getIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "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/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "The name of the KeyRing to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
+ "id": "cloudkms.projects.locations.keyRings.get",
+ "path": "v1/{+name}",
+ "description": "Returns metadata for a given KeyRing."
+ }
}
}
+ },
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameters": {
+ "name": {
+ "description": "The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "id": "cloudkms.projects.locations.list",
+ "path": "v1/{+name}/locations"
+ },
+ "get": {
+ "id": "cloudkms.projects.locations.get",
+ "path": "v1/{+name}",
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Location"
+ },
+ "parameters": {
+ "name": {
+ "description": "Resource name for the location.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}"
+ }
}
}
}
}
},
"parameters": {
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "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"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"callback": {
"description": "JSONP",
"type": "string",
@@ -1452,65 +1536,23 @@
"location": "query"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
}
},
"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.",
+ "description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.",
"kind": "discovery#restDescription",
"basePath": "",
"documentationLink": "https://cloud.google.com/kms/",
- "revision": "20170502",
- "id": "cloudkms:v1"
+ "id": "cloudkms:v1",
+ "revision": "20170530"
}
diff --git a/cloudkms/v1/cloudkms-gen.go b/cloudkms/v1/cloudkms-gen.go
index 5b62986..1da2263 100644
--- a/cloudkms/v1/cloudkms-gen.go
+++ b/cloudkms/v1/cloudkms-gen.go
@@ -291,6 +291,15 @@
// Binding: Associates `members` with a `role`.
type Binding struct {
+ // Condition: The condition that is associated with this binding.
+ // NOTE: an unsatisfied condition will not allow user access via
+ // current
+ // binding. Different bindings, including their conditions, are
+ // examined
+ // independently.
+ // This field is GOOGLE_INTERNAL.
+ Condition *Expr `json:"condition,omitempty"`
+
// Members: Specifies the identities requesting access for a Cloud
// Platform resource.
// `members` can have the following values:
@@ -317,6 +326,7 @@
// 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
@@ -331,7 +341,7 @@
// Required
Role string `json:"role,omitempty"`
- // ForceSendFields is a list of field names (e.g. "Members") to
+ // ForceSendFields is a list of field names (e.g. "Condition") 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
@@ -339,7 +349,7 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Members") to include in
+ // NullFields is a list of field names (e.g. "Condition") 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
@@ -356,6 +366,37 @@
// CloudAuditOptions: Write a Cloud Audit log
type CloudAuditOptions struct {
+ // LogName: The log_name to populate in the Cloud Audit Record.
+ //
+ // Possible values:
+ // "UNSPECIFIED_LOG_NAME" - Default. Should not be used.
+ // "ADMIN_ACTIVITY" - Corresponds to
+ // "cloudaudit.googleapis.com/activity"
+ // "DATA_ACCESS" - Corresponds to
+ // "cloudaudit.googleapis.com/data_access"
+ LogName string `json:"logName,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "LogName") 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. "LogName") 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 *CloudAuditOptions) MarshalJSON() ([]byte, error) {
+ type noMethod CloudAuditOptions
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Condition: A condition to be met.
@@ -379,7 +420,6 @@
// 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
@@ -801,6 +841,60 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// Expr: Represents an expression text. Example:
+//
+// title: "User account presence"
+// description: "Determines whether the request has a user account"
+// expression: "size(request.user) > 0"
+type Expr struct {
+ // Description: An optional description of the expression. This is a
+ // longer text which
+ // describes the expression, e.g. when hovered over it in a UI.
+ Description string `json:"description,omitempty"`
+
+ // Expression: Textual representation of an expression in
+ // [Common Expression Language](http://go/api-expr) syntax.
+ //
+ // The application context of the containing message determines
+ // which
+ // well-known feature set of CEL is supported.
+ Expression string `json:"expression,omitempty"`
+
+ // Location: An optional string indicating the location of the
+ // expression for error
+ // reporting, e.g. a file name and a position in the file.
+ Location string `json:"location,omitempty"`
+
+ // Title: An optional title for the expression, i.e. a short string
+ // describing
+ // its purpose. This can be used e.g. in UIs which allow to enter
+ // the
+ // expression.
+ Title string `json:"title,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 *Expr) MarshalJSON() ([]byte, error) {
+ type noMethod Expr
+ 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.
@@ -1128,8 +1222,6 @@
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"`
@@ -2819,7 +2911,7 @@
header_ http.Header
}
-// Decrypt: Decrypt data that was protected by Encrypt.
+// Decrypt: Decrypts 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
@@ -2913,7 +3005,7 @@
}
return ret, nil
// {
- // "description": "Decrypt data that was protected by Encrypt.",
+ // "description": "Decrypts 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",
@@ -2954,7 +3046,7 @@
header_ http.Header
}
-// Encrypt: Encrypt data, so that it can only be recovered by a call to
+// Encrypt: Encrypts 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)}
@@ -3049,7 +3141,7 @@
}
return ret, nil
// {
- // "description": "Encrypt data, so that it can only be recovered by a call to Decrypt.",
+ // "description": "Encrypts 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",
diff --git a/cloudresourcemanager/v1/cloudresourcemanager-api.json b/cloudresourcemanager/v1/cloudresourcemanager-api.json
index 40307a6..c79a7fa 100644
--- a/cloudresourcemanager/v1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1/cloudresourcemanager-api.json
@@ -1,35 +1,14 @@
{
- "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",
- "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": "20170503",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "id": "cloudresourcemanager:v1",
- "title": "Google Cloud Resource Manager API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"organizations": {
"methods": {
"setOrgPolicy": {
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ },
"response": {
"$ref": "OrgPolicy"
},
@@ -51,26 +30,19 @@
},
"flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
"path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.organizations.setOrgPolicy",
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- }
+ "id": "cloudresourcemanager.organizations.setOrgPolicy"
},
"setIamPolicy": {
- "id": "cloudresourcemanager.organizations.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "Policy"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"resource": {
"pattern": "^organizations/[^/]+$",
@@ -80,41 +52,21 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}:setIamPolicy"
- },
- "listAvailableOrgPolicyConstraints": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Name of the resource to list `Constraints` for.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "flatPath": "v1/organizations/{organizationsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".",
"request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ "$ref": "SetIamPolicyRequest"
}
},
"listOrgPolicies": {
+ "path": "v1/{+resource}:listOrgPolicies",
+ "id": "cloudresourcemanager.organizations.listOrgPolicies",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "description": "Lists all the `Policies` set for a particular resource.",
"response": {
"$ref": "ListOrgPoliciesResponse"
},
@@ -122,10 +74,6 @@
"resource"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"resource": {
"pattern": "^organizations/[^/]+$",
@@ -135,12 +83,39 @@
"type": "string"
}
},
- "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "id": "cloudresourcemanager.organizations.listOrgPolicies",
- "description": "Lists all the `Policies` set for a particular resource.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies"
+ },
+ "listAvailableOrgPolicyConstraints": {
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list `Constraints` for.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints",
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
"request": {
- "$ref": "ListOrgPoliciesRequest"
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
}
},
"getIamPolicy": {
@@ -153,11 +128,11 @@
"httpMethod": "POST",
"parameters": {
"resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -173,25 +148,31 @@
"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\"."
},
"search": {
- "httpMethod": "POST",
- "parameterOrder": [],
+ "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"
+ },
"response": {
"$ref": "SearchOrganizationsResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {},
"flatPath": "v1/organizations:search",
- "id": "cloudresourcemanager.organizations.search",
"path": "v1/organizations:search",
- "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"
- }
+ "id": "cloudresourcemanager.organizations.search"
},
"getOrgPolicy": {
+ "path": "v1/{+resource}:getOrgPolicy",
+ "id": "cloudresourcemanager.organizations.getOrgPolicy",
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
+ "request": {
+ "$ref": "GetOrgPolicyRequest"
+ },
"response": {
"$ref": "OrgPolicy"
},
@@ -212,21 +193,9 @@
"location": "path"
}
},
- "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.organizations.getOrgPolicy",
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "request": {
- "$ref": "GetOrgPolicyRequest"
- }
+ "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy"
},
"getEffectiveOrgPolicy": {
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy",
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
"response": {
"$ref": "OrgPolicy"
},
@@ -247,23 +216,29 @@
"type": "string"
}
},
- "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy"
+ "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy",
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ }
},
"get": {
- "httpMethod": "GET",
"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",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -271,25 +246,25 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/organizations/{organizationsId}",
- "id": "cloudresourcemanager.organizations.get",
"path": "v1/{+name}",
+ "id": "cloudresourcemanager.organizations.get",
"description": "Fetches an Organization resource identified by the specified resource name."
},
"testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "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",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -297,305 +272,19 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/organizations/{organizationsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
"id": "cloudresourcemanager.organizations.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\"."
},
"clearOrgPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "resource": {
- "description": "Name of the resource for the `Policy` to clear.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
"id": "cloudresourcemanager.organizations.clearOrgPolicy",
"path": "v1/{+resource}:clearOrgPolicy",
"request": {
"$ref": "ClearOrgPolicyRequest"
},
- "description": "Clears a `Policy` from a resource."
- }
- }
- },
- "liens": {
- "methods": {
- "create": {
- "description": "Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied.",
- "request": {
- "$ref": "Lien"
- },
- "response": {
- "$ref": "Lien"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {},
- "flatPath": "v1/liens",
- "path": "v1/liens",
- "id": "cloudresourcemanager.liens.create"
- },
- "delete": {
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.liens.delete",
- "description": "Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "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}"
- },
- "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",
- "response": {
- "$ref": "ListLiensResponse"
- },
- "parameterOrder": [],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "parent": {
- "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The `next_page_token` value returned from a previous List request, if any.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of items to return. This is a suggestion for the server.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/liens",
- "id": "cloudresourcemanager.liens.list",
- "path": "v1/liens"
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- }
- }
- },
- "folders": {
- "methods": {
- "setOrgPolicy": {
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.folders.setOrgPolicy",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- },
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`."
- },
- "listAvailableOrgPolicyConstraints": {
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints",
- "description": "Lists `Constraints` that could be applied on the specified resource.",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "description": "Name of the resource to list `Constraints` for.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints"
- },
- "listOrgPolicies": {
- "id": "cloudresourcemanager.folders.listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "description": "Lists all the `Policies` set for a particular resource.",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Name of the resource to list Policies for.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/folders/{foldersId}:listOrgPolicies"
- },
- "getOrgPolicy": {
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.folders.getOrgPolicy",
- "request": {
- "$ref": "GetOrgPolicyRequest"
- },
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "Name of the resource the `Policy` is set on.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/folders/{foldersId}:getOrgPolicy"
- },
- "getEffectiveOrgPolicy": {
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "The name of the resource to start computing the effective `Policy`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources."
- },
- "clearOrgPolicy": {
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
"description": "Clears a `Policy` from a resource.",
"httpMethod": "POST",
"parameterOrder": [
@@ -606,6 +295,147 @@
},
"parameters": {
"resource": {
+ "description": "Name of the resource for the `Policy` to clear.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy"
+ }
+ }
+ },
+ "liens": {
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Lien"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {},
+ "flatPath": "v1/liens",
+ "id": "cloudresourcemanager.liens.create",
+ "path": "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.",
+ "request": {
+ "$ref": "Lien"
+ }
+ },
+ "delete": {
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "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": {
+ "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",
+ "response": {
+ "$ref": "ListLiensResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "parent": {
+ "location": "query",
+ "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The `next_page_token` value returned from a previous List request, if any.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of items to return. This is a suggestion for the server.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "id": "cloudresourcemanager.operations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}"
+ }
+ }
+ },
+ "folders": {
+ "methods": {
+ "clearOrgPolicy": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
"pattern": "^folders/[^/]+$",
"location": "path",
"description": "Name of the resource for the `Policy` to clear.",
@@ -613,17 +443,295 @@
"type": "string"
}
},
+ "flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy",
+ "id": "cloudresourcemanager.folders.clearOrgPolicy",
+ "description": "Clears a `Policy` from a resource.",
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ }
+ },
+ "setOrgPolicy": {
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ },
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
- "id": "cloudresourcemanager.folders.clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy"
+ "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
+ "id": "cloudresourcemanager.folders.setOrgPolicy",
+ "path": "v1/{+resource}:setOrgPolicy"
+ },
+ "listAvailableOrgPolicyConstraints": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource to list `Constraints` for.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints",
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ }
+ },
+ "listOrgPolicies": {
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource to list Policies for.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/folders/{foldersId}:listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
+ "id": "cloudresourcemanager.folders.listOrgPolicies",
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ }
+ },
+ "getOrgPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource the `Policy` is set on.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/folders/{foldersId}:getOrgPolicy",
+ "id": "cloudresourcemanager.folders.getOrgPolicy",
+ "path": "v1/{+resource}:getOrgPolicy",
+ "request": {
+ "$ref": "GetOrgPolicyRequest"
+ },
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write."
+ },
+ "getEffectiveOrgPolicy": {
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ },
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources."
}
}
},
"projects": {
"methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the\nvalue `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"
+ },
+ "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"
+ }
+ },
+ "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",
+ "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."
+ },
+ "setOrgPolicy": {
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
+ "path": "v1/{+resource}:setOrgPolicy",
+ "id": "cloudresourcemanager.projects.setOrgPolicy",
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/projects",
+ "path": "v1/projects",
+ "id": "cloudresourcemanager.projects.create",
+ "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"
+ }
+ },
+ "listOrgPolicies": {
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list Policies for.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
+ "id": "cloudresourcemanager.projects.listOrgPolicies",
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ }
+ },
+ "get": {
+ "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.get"
+ },
"getAncestry": {
"id": "cloudresourcemanager.projects.getAncestry",
"path": "v1/projects/{projectId}:getAncestry",
@@ -640,10 +748,10 @@
},
"parameters": {
"projectId": {
+ "location": "path",
"description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -653,17 +761,13 @@
"flatPath": "v1/projects/{projectId}:getAncestry"
},
"testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified Project.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "TestIamPermissionsResponse"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
@@ -677,17 +781,21 @@
}
},
"flatPath": "v1/projects/{resource}:testIamPermissions",
+ "path": "v1/projects/{resource}:testIamPermissions",
"id": "cloudresourcemanager.projects.testIamPermissions",
- "path": "v1/projects/{resource}:testIamPermissions"
+ "description": "Returns permissions that a caller has on the specified Project.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
},
"delete": {
"httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"projectId"
],
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -712,41 +820,34 @@
"resource"
],
"httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource for the `Policy` to clear.",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "resource": {
- "description": "Name of the resource for the `Policy` to clear.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
"flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
"path": "v1/{+resource}:clearOrgPolicy",
"id": "cloudresourcemanager.projects.clearOrgPolicy",
- "description": "Clears a `Policy` from a resource.",
"request": {
"$ref": "ClearOrgPolicyRequest"
- }
+ },
+ "description": "Clears a `Policy` from a resource."
},
"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\nremove 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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "Policy"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "parameterOrder": [
+ "resource"
],
+ "httpMethod": "POST",
"parameters": {
"resource": {
"location": "path",
@@ -755,11 +856,22 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{resource}:setIamPolicy",
+ "path": "v1/projects/{resource}:setIamPolicy",
"id": "cloudresourcemanager.projects.setIamPolicy",
- "path": "v1/projects/{resource}: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\nremove 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."
},
"listAvailableOrgPolicyConstraints": {
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -767,39 +879,35 @@
"response": {
"$ref": "ListAvailableOrgPolicyConstraintsResponse"
},
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Name of the resource to list `Constraints` for.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list `Constraints` for.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
"flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints",
"id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "description": "Lists `Constraints` that could be applied on the specified resource."
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints"
},
"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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "Policy"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"resource": {
"location": "path",
@@ -808,22 +916,22 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"flatPath": "v1/projects/{resource}:getIamPolicy",
+ "path": "v1/projects/{resource}:getIamPolicy",
"id": "cloudresourcemanager.projects.getIamPolicy",
- "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"
+ }
},
"getOrgPolicy": {
- "response": {
- "$ref": "OrgPolicy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "OrgPolicy"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
@@ -838,47 +946,14 @@
}
},
"flatPath": "v1/projects/{projectsId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
"id": "cloudresourcemanager.projects.getOrgPolicy",
+ "path": "v1/{+resource}:getOrgPolicy",
"description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
"request": {
"$ref": "GetOrgPolicyRequest"
}
},
- "getEffectiveOrgPolicy": {
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the resource to start computing the effective `Policy`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy"
- },
"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"
},
@@ -888,10 +963,10 @@
"httpMethod": "POST",
"parameters": {
"projectId": {
- "location": "path",
"description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -899,131 +974,31 @@
],
"flatPath": "v1/projects/{projectId}:undelete",
"path": "v1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete"
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Project"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.undelete",
"request": {
- "$ref": "Project"
+ "$ref": "UndeleteProjectRequest"
},
- "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."
+ "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."
},
- "list": {
- "response": {
- "$ref": "ListProjectsResponse"
+ "getEffectiveOrgPolicy": {
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
},
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "filter": {
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the\nvalue `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"
- },
- "pageSize": {
- "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/projects",
- "path": "v1/projects",
- "id": "cloudresourcemanager.projects.list",
- "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nNew Projects do not necessarily appear at the end of the list."
- },
- "setOrgPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
"response": {
"$ref": "OrgPolicy"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
- "id": "cloudresourcemanager.projects.setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- }
- },
- "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"
- }
- },
- "listOrgPolicies": {
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "description": "Lists all the `Policies` set for a particular resource.",
- "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
+ "httpMethod": "POST",
"parameters": {
"resource": {
"pattern": "^projects/[^/]+$",
"location": "path",
- "description": "Name of the resource to list Policies for.",
+ "description": "The name of the resource to start computing the effective `Policy`.",
"required": true,
"type": "string"
}
@@ -1032,49 +1007,49 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/projects/{projectsId}:listOrgPolicies",
- "id": "cloudresourcemanager.projects.listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies"
+ "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy"
},
- "get": {
+ "update": {
"response": {
"$ref": "Project"
},
"parameterOrder": [
"projectId"
],
- "httpMethod": "GET",
+ "httpMethod": "PUT",
"parameters": {
"projectId": {
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "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"
+ "https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}",
"path": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get",
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project."
+ "id": "cloudresourcemanager.projects.update",
+ "request": {
+ "$ref": "Project"
+ },
+ "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project."
}
}
}
},
"parameters": {
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
@@ -1087,22 +1062,22 @@
"type": "string"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"alt": {
"enumDescriptions": [
@@ -1121,9 +1096,9 @@
"type": "string"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"key": {
"location": "query",
@@ -1136,487 +1111,23 @@
"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",
- "location": "query"
+ "type": "string"
}
},
"schemas": {
- "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"
- },
- "FolderOperation": {
- "properties": {
- "operationType": {
- "enumDescriptions": [
- "Operation type not specified.",
- "A create folder operation.",
- "A move folder operation."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE",
- "MOVE"
- ],
- "description": "The type of this operation.",
- "type": "string"
- },
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- },
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "type": "string"
- }
- },
- "id": "FolderOperation",
- "description": "Metadata describing a long running folder operation",
- "type": "object"
- },
- "Policy": {
- "properties": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32",
- "type": "integer"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- }
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\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"
- },
- "ListAvailableOrgPolicyConstraintsRequest": {
- "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
- "type": "string"
- },
- "pageSize": {
- "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "ResourceId": {
- "properties": {
- "type": {
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
- "type": "string"
- },
- "id": {
- "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
- "type": "string"
- }
- },
- "id": "ResourceId",
- "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"
- },
- "GetEffectiveOrgPolicyRequest": {
- "description": "The request sent to the GetEffectiveOrgPolicy method.",
- "type": "object",
- "properties": {
- "constraint": {
- "description": "The name of the `Constraint` to compute the effective `Policy`.",
- "type": "string"
- }
- },
- "id": "GetEffectiveOrgPolicyRequest"
- },
- "ListOrgPoliciesRequest": {
- "description": "The request sent to the ListOrgPolicies method.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
- "type": "string"
- },
- "pageSize": {
- "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListOrgPoliciesRequest"
- },
- "Operation": {
- "properties": {
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- }
- },
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
- },
- "AuditConfig": {
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- }
- },
- "id": "AuditConfig",
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object"
- },
- "Constraint": {
- "description": "A `Constraint` describes a way in which a resource's configuration can be\nrestricted. For example, it controls which cloud services can be activated\nacross an organization, or whether a Compute Engine instance can have\nserial port connections established. `Constraints` can be configured by the\norganization's policy adminstrator to fit the needs of the organzation by\nsetting Policies for `Constraints` at different locations in the\norganization's resource hierarchy. Policies are inherited down the resource\nhierarchy from higher levels, but can also be overridden. For details about\nthe inheritance rules please read about\nPolicies.\n\n`Constraints` have a default behavior determined by the `constraint_default`\nfield, which is the enforcement behavior that is used in the absence of a\n`Policy` being defined or inherited for the resource in question.",
- "type": "object",
- "properties": {
- "booleanConstraint": {
- "$ref": "BooleanConstraint",
- "description": "Defines this constraint as being a BooleanConstraint."
- },
- "constraintDefault": {
- "enumDescriptions": [
- "This is only used for distinguishing unset values and should never be\nused.",
- "Indicate that all values are allowed for list constraints.\nIndicate that enforcement is off for boolean constraints.",
- "Indicate that all values are denied for list constraints.\nIndicate that enforcement is on for boolean constraints."
- ],
- "enum": [
- "CONSTRAINT_DEFAULT_UNSPECIFIED",
- "ALLOW",
- "DENY"
- ],
- "description": "The evaluation behavior of this constraint in the absense of 'Policy'.",
- "type": "string"
- },
- "name": {
- "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`",
- "type": "string"
- },
- "listConstraint": {
- "$ref": "ListConstraint",
- "description": "Defines this constraint as being a ListConstraint."
- },
- "version": {
- "description": "Version of the `Constraint`. Default version is 0;",
- "format": "int32",
- "type": "integer"
- },
- "description": {
- "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.",
- "type": "string"
- },
- "displayName": {
- "description": "The human readable name.\n\nMutable.",
- "type": "string"
- }
- },
- "id": "Constraint"
- },
- "ListLiensResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
- "type": "string"
- },
- "liens": {
- "description": "A list of Liens.",
- "type": "array",
- "items": {
- "$ref": "Lien"
- }
- }
- },
- "id": "ListLiensResponse",
- "description": "The response message for Liens.ListLiens.",
- "type": "object"
- },
- "Status": {
- "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",
- "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": {
- "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"
- },
- "GetOrgPolicyRequest": {
- "description": "The request sent to the GetOrgPolicy method.",
- "type": "object",
- "properties": {
- "constraint": {
- "description": "Name of the `Constraint` to get the `Policy`.",
- "type": "string"
- }
- },
- "id": "GetOrgPolicyRequest"
- },
- "RestoreDefault": {
- "description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.",
- "type": "object",
- "properties": {},
- "id": "RestoreDefault"
- },
- "UndeleteProjectRequest": {
- "properties": {},
- "id": "UndeleteProjectRequest",
- "description": "The request sent to the UndeleteProject\nmethod.",
- "type": "object"
- },
- "ClearOrgPolicyRequest": {
- "description": "The request sent to the ClearOrgPolicy method.",
- "type": "object",
- "properties": {
- "etag": {
- "description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.",
- "format": "byte",
- "type": "string"
- },
- "constraint": {
- "description": "Name of the `Constraint` of the `Policy` to clear.",
- "type": "string"
- }
- },
- "id": "ClearOrgPolicyRequest"
- },
- "ProjectCreationStatus": {
- "properties": {
- "ready": {
- "description": "True if the project creation process is complete.",
- "type": "boolean"
- },
- "createTime": {
- "description": "Creation time of the project creation workflow.",
- "format": "google-datetime",
- "type": "string"
- },
- "gettable": {
- "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
- "type": "boolean"
- }
- },
- "id": "ProjectCreationStatus",
- "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
- "type": "object"
- },
- "BooleanConstraint": {
- "properties": {},
- "id": "BooleanConstraint",
- "description": "A `Constraint` that is either enforced or not.\n\nFor example a constraint `constraints/compute.disableSerialPortAccess`.\nIf it is enforced on a VM instance, serial port connections will not be\nopened to that instance.",
- "type": "object"
- },
- "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": {
- "properties": {
- "directoryCustomerId": {
- "description": "The Google for Work customer id used in the Directory API.",
- "type": "string"
- }
- },
- "id": "OrganizationOwner",
- "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
- "type": "object"
- },
- "ListProjectsResponse": {
- "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",
- "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": {
- "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": {
- "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."
- ]
- },
- "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"
- }
- },
- "id": "Project"
- },
"ListOrgPoliciesResponse": {
"properties": {
"nextPageToken": {
@@ -1654,8 +1165,6 @@
"id": "SearchOrganizationsResponse"
},
"FolderOperationError": {
- "description": "A classification of the Folder Operation error.",
- "type": "object",
"properties": {
"errorMessageId": {
"enumDescriptions": [
@@ -1672,39 +1181,26 @@
],
"enum": [
"ERROR_TYPE_UNSPECIFIED",
- "FOLDER_HEIGHT_VIOLATION",
+ "ACTIVE_FOLDER_HEIGHT_VIOLATION",
"MAX_CHILD_FOLDERS_VIOLATION",
"FOLDER_NAME_UNIQUENESS_VIOLATION",
- "RESOURCE_DELETED",
- "PARENT_DELETED",
- "CYCLE_INTRODUCED_ERROR",
- "FOLDER_BEING_MOVED",
- "FOLDER_TO_DELETE_NON_EMPTY",
+ "RESOURCE_DELETED_VIOLATION",
+ "PARENT_DELETED_VIOLATION",
+ "CYCLE_INTRODUCED_VIOLATION",
+ "FOLDER_BEING_MOVED_VIOLATION",
+ "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
"DELETED_FOLDER_HEIGHT_VIOLATION"
],
"description": "The type of operation error experienced.",
"type": "string"
}
},
- "id": "FolderOperationError"
+ "id": "FolderOperationError",
+ "description": "A classification of the Folder Operation error.",
+ "type": "object"
},
"OrgPolicy": {
- "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.",
- "type": "object",
"properties": {
- "version": {
- "description": "Version of the `Policy`. Default version is 0;",
- "format": "int32",
- "type": "integer"
- },
- "restoreDefault": {
- "$ref": "RestoreDefault",
- "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
- },
- "listPolicy": {
- "description": "List of values either allowed or disallowed.",
- "$ref": "ListPolicy"
- },
"etag": {
"description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
"format": "byte",
@@ -1715,27 +1211,42 @@
"type": "string"
},
"booleanPolicy": {
- "$ref": "BooleanPolicy",
- "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not."
+ "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not.",
+ "$ref": "BooleanPolicy"
},
"updateTime": {
"description": "The time stamp the `Policy` was previously updated. This is set by the\nserver, not specified by the caller, and represents the last time a call to\n`SetOrgPolicy` was made for that `Policy`. Any value set by the client will\nbe ignored.",
"format": "google-datetime",
"type": "string"
+ },
+ "version": {
+ "description": "Version of the `Policy`. Default version is 0;",
+ "format": "int32",
+ "type": "integer"
+ },
+ "restoreDefault": {
+ "$ref": "RestoreDefault",
+ "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
+ },
+ "listPolicy": {
+ "$ref": "ListPolicy",
+ "description": "List of values either allowed or disallowed."
}
},
- "id": "OrgPolicy"
+ "id": "OrgPolicy",
+ "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.",
+ "type": "object"
},
"BooleanPolicy": {
- "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
- "type": "object",
"properties": {
"enforced": {
"description": "If `true`, then the `Policy` is enforced. If `false`, then any\nconfiguration is acceptable.\n\nSuppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`\nwith `constraint_default` set to `ALLOW`. A `Policy` for that\n`Constraint` exhibits the following behavior:\n - If the `Policy` at this resource has enforced set to `false`, serial\n port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial\n port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port\n connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the\n resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the\n resource hierarchy, the behavior is as if the`Policy` were set at\n this resource.\n\nThe following examples demonstrate the different possible layerings:\n\nExample 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\nThe constraint at `projects/bar` and `organizations/foo` will not be\nenforced.\n\nExample 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\nThe constraint at `organizations/foo` is not enforced.\nThe constraint at `projects/bar` is enforced.\n\nExample 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: {}}\nThe constraint at `organizations/foo` is enforced.\nThe constraint at `projects/bar` is not enforced, because\n`constraint_default` for the `Constraint` is `ALLOW`.",
"type": "boolean"
}
},
- "id": "BooleanPolicy"
+ "id": "BooleanPolicy",
+ "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
+ "type": "object"
},
"Lien": {
"properties": {
@@ -1748,6 +1259,10 @@
"format": "google-datetime",
"type": "string"
},
+ "origin": {
+ "description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'",
+ "type": "string"
+ },
"name": {
"description": "A system-generated unique identifier for this Lien.\n\nExample: `liens/1234abcd`",
"type": "string"
@@ -1756,10 +1271,6 @@
"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",
@@ -1773,15 +1284,15 @@
"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"
+ "$ref": "ResourceId",
+ "description": "Resource id of the ancestor."
}
},
- "id": "Ancestor",
- "description": "Identifying information for a single ancestor of a project.",
- "type": "object"
+ "id": "Ancestor"
},
"ListConstraint": {
"properties": {
@@ -1797,8 +1308,8 @@
"SetOrgPolicyRequest": {
"properties": {
"policy": {
- "description": "`Policy` to set on the resource.",
- "$ref": "OrgPolicy"
+ "$ref": "OrgPolicy",
+ "description": "`Policy` to set on the resource."
}
},
"id": "SetOrgPolicyRequest",
@@ -1806,20 +1317,20 @@
"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"
- },
"updateMask": {
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"format": "google-fieldmask",
"type": "string"
+ },
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
}
},
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
+ "id": "SetIamPolicyRequest"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
@@ -1828,8 +1339,6 @@
"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",
@@ -1841,18 +1350,18 @@
"$ref": "OrganizationOwner"
},
"lifecycleState": {
+ "enumDescriptions": [
+ "Unspecified state. This is only useful for distinguishing unset values.",
+ "The normal and active state.",
+ "The organization has been marked for deletion by the user."
+ ],
"enum": [
"LIFECYCLE_STATE_UNSPECIFIED",
"ACTIVE",
"DELETE_REQUESTED"
],
"description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
- "type": "string",
- "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"
},
"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\".",
@@ -1863,7 +1372,9 @@
"type": "string"
}
},
- "id": "Organization"
+ "id": "Organization",
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
+ "type": "object"
},
"ListAvailableOrgPolicyConstraintsResponse": {
"description": "The response returned from the ListAvailableOrgPolicyConstraints method.\nReturns all `Constraints` that could be set at this level of the hierarchy\n(contrast with the response from `ListPolicies`, which returns all policies\nwhich are set).",
@@ -1884,9 +1395,21 @@
"id": "ListAvailableOrgPolicyConstraintsResponse"
},
"ListPolicy": {
- "description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\nA `ListPolicy` can define specific values that are allowed or denied by\nsetting either the `allowed_values` or `denied_values` fields. It can also\nbe used to allow or deny all values, by setting the `all_values` field. If\n`all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`\nor `denied_values` must be set (attempting to set both or neither will\nresult in a failed request). If `all_values` is set to either `ALLOW` or\n`DENY`, `allowed_values` and `denied_values` must be unset.",
- "type": "object",
"properties": {
+ "allValues": {
+ "enum": [
+ "ALL_VALUES_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "The policy all_values state.",
+ "type": "string",
+ "enumDescriptions": [
+ "Indicates that either allowed_values or denied_values must be set.",
+ "A policy with this set allows all values.",
+ "A policy with this set denies all values."
+ ]
+ },
"allowedValues": {
"description": "List of values allowed at this resource. an only be set if no values are\nset for `denied_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
"type": "array",
@@ -1908,27 +1431,13 @@
"items": {
"type": "string"
}
- },
- "allValues": {
- "enumDescriptions": [
- "Indicates that either allowed_values or denied_values must be set.",
- "A policy with this set allows all values.",
- "A policy with this set denies all values."
- ],
- "enum": [
- "ALL_VALUES_UNSPECIFIED",
- "ALLOW",
- "DENY"
- ],
- "description": "The policy all_values state.",
- "type": "string"
}
},
- "id": "ListPolicy"
+ "id": "ListPolicy",
+ "description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\nA `ListPolicy` can define specific values that are allowed or denied by\nsetting either the `allowed_values` or `denied_values` fields. It can also\nbe used to allow or deny all values, by setting the `all_values` field. If\n`all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`\nor `denied_values` must be set (attempting to set both or neither will\nresult in a failed request). If `all_values` is set to either `ALLOW` or\n`DENY`, `allowed_values` and `denied_values` must be unset.",
+ "type": "object"
},
"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.",
@@ -1938,7 +1447,9 @@
}
}
},
- "id": "GetAncestryResponse"
+ "id": "GetAncestryResponse",
+ "description": "Response from the GetAncestry method.",
+ "type": "object"
},
"AuditLogConfig": {
"properties": {
@@ -1971,6 +1482,8 @@
"type": "object"
},
"SearchOrganizationsRequest": {
+ "description": "The request sent to the `SearchOrganizations` method.",
+ "type": "object",
"properties": {
"pageToken": {
"description": "A pagination token returned from a previous call to `SearchOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
@@ -1986,22 +1499,509 @@
"type": "string"
}
},
- "id": "SearchOrganizationsRequest",
- "description": "The request sent to the `SearchOrganizations` method.",
- "type": "object"
+ "id": "SearchOrganizationsRequest"
},
"GetAncestryRequest": {
- "properties": {},
- "id": "GetAncestryRequest",
"description": "The request sent to the\nGetAncestry\nmethod.",
+ "type": "object",
+ "properties": {},
+ "id": "GetAncestryRequest"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "ListAvailableOrgPolicyConstraintsRequest": {
+ "properties": {
+ "pageToken": {
+ "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListAvailableOrgPolicyConstraintsRequest",
+ "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
"type": "object"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "type": "array",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\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"
+ },
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
+ "type": "object",
+ "properties": {
+ "operationType": {
+ "enumDescriptions": [
+ "Operation type not specified.",
+ "A create folder operation.",
+ "A move folder operation."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE",
+ "MOVE"
+ ],
+ "description": "The type of this operation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name of the folder.",
+ "type": "string"
+ },
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
+ },
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
+ "type": "string"
+ }
+ },
+ "id": "FolderOperation"
+ },
+ "ResourceId": {
+ "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
+ "type": "string"
+ },
+ "id": {
+ "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
+ "type": "string"
+ }
+ },
+ "id": "ResourceId"
+ },
+ "GetEffectiveOrgPolicyRequest": {
+ "properties": {
+ "constraint": {
+ "description": "The name of the `Constraint` to compute the effective `Policy`.",
+ "type": "string"
+ }
+ },
+ "id": "GetEffectiveOrgPolicyRequest",
+ "description": "The request sent to the GetEffectiveOrgPolicy method.",
+ "type": "object"
+ },
+ "ListOrgPoliciesRequest": {
+ "description": "The request sent to the ListOrgPolicies method.",
+ "type": "object",
+ "properties": {
+ "pageToken": {
+ "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListOrgPoliciesRequest"
+ },
+ "Operation": {
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
+ },
+ "AuditConfig": {
+ "properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ }
+ },
+ "id": "AuditConfig",
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object"
+ },
+ "ListLiensResponse": {
+ "description": "The response message for Liens.ListLiens.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
+ "type": "string"
+ },
+ "liens": {
+ "description": "A list of Liens.",
+ "type": "array",
+ "items": {
+ "$ref": "Lien"
+ }
+ }
+ },
+ "id": "ListLiensResponse"
+ },
+ "Status": {
+ "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",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
+ },
+ "Constraint": {
+ "properties": {
+ "constraintDefault": {
+ "enumDescriptions": [
+ "This is only used for distinguishing unset values and should never be\nused.",
+ "Indicate that all values are allowed for list constraints.\nIndicate that enforcement is off for boolean constraints.",
+ "Indicate that all values are denied for list constraints.\nIndicate that enforcement is on for boolean constraints."
+ ],
+ "enum": [
+ "CONSTRAINT_DEFAULT_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "The evaluation behavior of this constraint in the absense of 'Policy'.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`",
+ "type": "string"
+ },
+ "listConstraint": {
+ "description": "Defines this constraint as being a ListConstraint.",
+ "$ref": "ListConstraint"
+ },
+ "version": {
+ "description": "Version of the `Constraint`. Default version is 0;",
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": {
+ "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The human readable name.\n\nMutable.",
+ "type": "string"
+ },
+ "booleanConstraint": {
+ "description": "Defines this constraint as being a BooleanConstraint.",
+ "$ref": "BooleanConstraint"
+ }
+ },
+ "id": "Constraint",
+ "description": "A `Constraint` describes a way in which a resource's configuration can be\nrestricted. For example, it controls which cloud services can be activated\nacross an organization, or whether a Compute Engine instance can have\nserial port connections established. `Constraints` can be configured by the\norganization's policy adminstrator to fit the needs of the organzation by\nsetting Policies for `Constraints` at different locations in the\norganization's resource hierarchy. Policies are inherited down the resource\nhierarchy from higher levels, but can also be overridden. For details about\nthe inheritance rules please read about\nPolicies.\n\n`Constraints` have a default behavior determined by the `constraint_default`\nfield, which is the enforcement behavior that is used in the absence of a\n`Policy` being defined or inherited for the resource in question.",
+ "type": "object"
+ },
+ "Binding": {
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
+ },
+ "GetOrgPolicyRequest": {
+ "properties": {
+ "constraint": {
+ "description": "Name of the `Constraint` to get the `Policy`.",
+ "type": "string"
+ }
+ },
+ "id": "GetOrgPolicyRequest",
+ "description": "The request sent to the GetOrgPolicy method.",
+ "type": "object"
+ },
+ "RestoreDefault": {
+ "description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.",
+ "type": "object",
+ "properties": {},
+ "id": "RestoreDefault"
+ },
+ "ClearOrgPolicyRequest": {
+ "properties": {
+ "etag": {
+ "description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "constraint": {
+ "description": "Name of the `Constraint` of the `Policy` to clear.",
+ "type": "string"
+ }
+ },
+ "id": "ClearOrgPolicyRequest",
+ "description": "The request sent to the ClearOrgPolicy method.",
+ "type": "object"
+ },
+ "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"
+ },
+ "BooleanConstraint": {
+ "properties": {},
+ "id": "BooleanConstraint",
+ "description": "A `Constraint` that is either enforced or not.\n\nFor example a constraint `constraints/compute.disableSerialPortAccess`.\nIf it is enforced on a VM instance, serial port connections will not be\nopened to that instance.",
+ "type": "object"
+ },
+ "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": {
+ "projects": {
+ "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
+ "type": "array",
+ "items": {
+ "$ref": "Project"
+ }
+ },
+ "nextPageToken": {
+ "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
+ "type": "string"
+ }
+ },
+ "id": "ListProjectsResponse"
+ },
+ "Project": {
+ "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.",
+ "type": "object",
+ "properties": {
+ "lifecycleState": {
+ "enumDescriptions": [
+ "Unspecified state. This is only used/useful for distinguishing\nunset values.",
+ "The normal and active state.",
+ "The project has been marked for deletion by the user\n(by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
+ "This lifecycle state is no longer used and not returned by the API."
+ ],
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED",
+ "DELETE_IN_PROGRESS"
+ ],
+ "description": "The Project lifecycle state.\n\nRead-only.",
+ "type": "string"
+ },
+ "projectNumber": {
+ "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "parent": {
+ "description": "An optional reference to a parent Resource.\n\nThe only supported parent type is \"organization\". Once set, the parent\ncannot be modified. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write.",
+ "$ref": "ResourceId"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
+ "type": "object"
+ },
+ "createTime": {
+ "description": "Creation time.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.",
+ "type": "string"
+ }
+ },
+ "id": "Project"
}
},
- "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": "v1",
- "baseUrl": "https://cloudresourcemanager.googleapis.com/"
+ "baseUrl": "https://cloudresourcemanager.googleapis.com/",
+ "canonicalName": "Cloud Resource Manager",
+ "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"
+ }
+ }
+ }
+ },
+ "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",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "id": "cloudresourcemanager:v1",
+ "revision": "20170524",
+ "title": "Google Cloud Resource Manager API"
}
diff --git a/cloudresourcemanager/v1/cloudresourcemanager-gen.go b/cloudresourcemanager/v1/cloudresourcemanager-gen.go
index 9b7a185..fe00f7d 100644
--- a/cloudresourcemanager/v1/cloudresourcemanager-gen.go
+++ b/cloudresourcemanager/v1/cloudresourcemanager-gen.go
@@ -346,6 +346,7 @@
// 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
@@ -673,22 +674,23 @@
// Possible values:
// "ERROR_TYPE_UNSPECIFIED" - The error type was unrecognized or
// unspecified.
- // "FOLDER_HEIGHT_VIOLATION" - The attempted action would violate the
- // max folder depth constraint.
+ // "ACTIVE_FOLDER_HEIGHT_VIOLATION" - The attempted action would
+ // violate the max folder depth constraint.
// "MAX_CHILD_FOLDERS_VIOLATION" - The attempted action would violate
// the max child folders constraint.
// "FOLDER_NAME_UNIQUENESS_VIOLATION" - The attempted action would
// violate the locally-unique folder
// display_name constraint.
- // "RESOURCE_DELETED" - The resource being moved has been deleted.
- // "PARENT_DELETED" - The resource a folder was being added to has
- // been deleted.
- // "CYCLE_INTRODUCED_ERROR" - The attempted action would introduce
+ // "RESOURCE_DELETED_VIOLATION" - The resource being moved has been
+ // deleted.
+ // "PARENT_DELETED_VIOLATION" - The resource a folder was being added
+ // to has been deleted.
+ // "CYCLE_INTRODUCED_VIOLATION" - The attempted action would introduce
// cycle in resource path.
- // "FOLDER_BEING_MOVED" - The attempted action would move a folder
- // that is already being moved.
- // "FOLDER_TO_DELETE_NON_EMPTY" - The folder the caller is trying to
- // delete contains active resources.
+ // "FOLDER_BEING_MOVED_VIOLATION" - The attempted action would move a
+ // folder that is already being moved.
+ // "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION" - The folder the caller is
+ // trying to delete contains active resources.
// "DELETED_FOLDER_HEIGHT_VIOLATION" - The attempted action would
// violate the max deleted folder depth
// constraint.
@@ -2162,7 +2164,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -2195,7 +2197,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
diff --git a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
index 992a930..60a5eb6 100644
--- a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
@@ -1,157 +1,71 @@
{
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
- "organizations": {
+ "projects": {
"methods": {
- "list": {
- "path": "v1beta1/organizations",
- "id": "cloudresourcemanager.organizations.list",
- "description": "Lists Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the list.",
- "response": {
- "$ref": "ListOrganizationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/organizations"
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
- "id": "cloudresourcemanager.organizations.setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "getIamPolicy": {
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".",
- "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"
- },
- "get": {
- "description": "Fetches an Organization resource identified by the specified resource name.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- },
- "organizationId": {
- "location": "query",
- "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "id": "cloudresourcemanager.organizations.get",
- "path": "v1beta1/{+name}"
- },
"update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Organization"
+ "path": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.update",
+ "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
+ "request": {
+ "$ref": "Project"
},
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"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\".",
+ "projectId": {
+ "location": "path",
+ "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
"required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "id": "cloudresourcemanager.organizations.update",
- "path": "v1beta1/{+name}",
- "description": "Updates an Organization resource identified by the specified resource name.",
+ "flatPath": "v1beta1/projects/{projectId}"
+ },
+ "getAncestry": {
+ "id": "cloudresourcemanager.projects.getAncestry",
+ "path": "v1beta1/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": "Organization"
- }
+ "$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": "v1beta1/projects/{projectId}:getAncestry"
},
"testIamPermissions": {
+ "id": "cloudresourcemanager.projects.testIamPermissions",
+ "path": "v1beta1/projects/{resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified Project.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -159,31 +73,128 @@
"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",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "flatPath": "v1beta1/projects/{resource}:testIamPermissions"
+ },
+ "delete": {
+ "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}",
+ "path": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the\nvalue `red` and its label `size` has the value `big`.\n\nOptional.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/projects",
+ "path": "v1beta1/projects",
+ "id": "cloudresourcemanager.projects.list",
+ "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."
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the IAM access control policy for the specified Project. Replaces\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ There must be at least one owner who has accepted the Terms of\nService (ToS) agreement in the policy. Calling `setIamPolicy()` to\nremove 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.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"parameters": {
"resource": {
- "pattern": "^organizations/[^/]+$",
"location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "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/organizations/{organizationsId}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions",
- "path": "v1beta1/{+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\".",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
+ "path": "v1beta1/projects/{resource}:setIamPolicy",
+ "id": "cloudresourcemanager.projects.setIamPolicy"
+ },
+ "create": {
"request": {
- "$ref": "TestIamPermissionsRequest"
- }
- }
- }
- },
- "projects": {
- "methods": {
+ "$ref": "Project"
+ },
+ "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage.",
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {
+ "useLegacyStack": {
+ "location": "query",
+ "description": "A safety hatch to opt out of the new reliable project creation process.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects",
+ "path": "v1beta1/projects",
+ "id": "cloudresourcemanager.projects.create"
+ },
"getIamPolicy": {
"response": {
"$ref": "Policy"
@@ -238,197 +249,37 @@
"description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project."
},
"undelete": {
- "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": "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"
},
- "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."
- },
- "getAncestry": {
- "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "request": {
- "$ref": "GetAncestryRequest"
- },
- "response": {
- "$ref": "GetAncestryResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "projectId": {
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}:getAncestry",
- "path": "v1beta1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry"
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Project"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "path": "v1beta1/projects/{projectId}",
- "request": {
- "$ref": "Project"
- },
- "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project."
- },
- "testIamPermissions": {
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "path": "v1beta1/projects/{resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Project.",
- "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",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects/{resource}:testIamPermissions"
- },
- "delete": {
- "id": "cloudresourcemanager.projects.delete",
- "path": "v1beta1/projects/{projectId}",
- "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
- "parameterOrder": [
- "projectId"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"projectId": {
- "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
"required": true,
"type": "string",
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "pageToken": {
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the\nvalue `red` and its label `size` has the value `big`.\n\nOptional.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "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": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Project"
- },
- "parameters": {
- "useLegacyStack": {
- "location": "query",
- "description": "A safety hatch to opt out of the new reliable project creation process.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.create",
- "path": "v1beta1/projects",
- "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."
- },
- "setIamPolicy": {
+ "flatPath": "v1beta1/projects/{projectId}:undelete",
+ "id": "cloudresourcemanager.projects.undelete",
+ "path": "v1beta1/projects/{projectId}:undelete"
+ }
+ }
+ },
+ "organizations": {
+ "methods": {
+ "getIamPolicy": {
"response": {
"$ref": "Policy"
},
@@ -436,38 +287,194 @@
"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 specified.\nSee the operation documentation for the appropriate value for this field.",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
"type": "string",
+ "pattern": "^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"
+ }
+ },
+ "get": {
+ "id": "cloudresourcemanager.organizations.get",
+ "path": "v1beta1/{+name}",
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "organizationId": {
+ "location": "query",
+ "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/organizations/{organizationsId}"
+ },
+ "update": {
+ "request": {
+ "$ref": "Organization"
+ },
+ "description": "Updates an Organization resource identified by the specified resource name.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
- "path": "v1beta1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy",
+ "flatPath": "v1beta1/organizations/{organizationsId}",
+ "id": "cloudresourcemanager.organizations.update",
+ "path": "v1beta1/{+name}"
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "path": "v1beta1/{+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"
+ }
+ },
+ "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": {
+ "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"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "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": {
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".",
"request": {
"$ref": "SetIamPolicyRequest"
},
- "description": "Sets the IAM access control policy for the specified Project. Replaces\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ There must be at least one owner who has accepted the Terms of\nService (ToS) agreement in the policy. Calling `setIamPolicy()` to\nremove 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."
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy"
}
}
}
},
"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"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enum": [
@@ -482,11 +489,6 @@
],
"location": "query"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
"enum": [
"json",
@@ -503,15 +505,15 @@
"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": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -519,14 +521,9 @@
"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": {
@@ -534,326 +531,27 @@
"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",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
}
},
"schemas": {
- "AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- }
- },
- "id": "AuditConfig"
- },
- "Ancestor": {
- "properties": {
- "resourceId": {
- "$ref": "ResourceId",
- "description": "Resource id of the ancestor."
- }
- },
- "id": "Ancestor",
- "description": "Identifying information for a single ancestor of a project.",
- "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"
- },
- "ListOrganizationsResponse": {
- "description": "The response returned from the `ListOrganizations` 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 list query, possibly paginated.",
- "type": "array",
- "items": {
- "$ref": "Organization"
- }
- }
- },
- "id": "ListOrganizationsResponse"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "UndeleteProjectRequest": {
- "description": "The request sent to the UndeleteProject\nmethod.",
- "type": "object",
- "properties": {},
- "id": "UndeleteProjectRequest"
- },
- "Organization": {
- "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
- "type": "object",
- "properties": {
- "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"
- },
- "displayName": {
- "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
- "type": "string"
- },
- "creationTime": {
- "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "owner": {
- "$ref": "OrganizationOwner",
- "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
- },
- "name": {
- "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
- "type": "string"
- },
- "organizationId": {
- "description": "An immutable id for the Organization that is assigned on creation. This\nshould be omitted when creating a new Organization.\nThis field is read-only.\nThis field is deprecated and will be removed in v1. Use name instead.",
- "type": "string"
- }
- },
- "id": "Organization"
- },
- "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": {
- "properties": {
- "directoryCustomerId": {
- "description": "The Google for Work customer id used in the Directory API.",
- "type": "string"
- }
- },
- "id": "OrganizationOwner",
- "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
- "type": "object"
- },
- "GetAncestryResponse": {
- "properties": {
- "ancestor": {
- "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
- "type": "array",
- "items": {
- "$ref": "Ancestor"
- }
- }
- },
- "id": "GetAncestryResponse",
- "description": "Response from the GetAncestry method.",
- "type": "object"
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "logType": {
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ]
- }
- },
- "id": "AuditLogConfig"
- },
- "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"
- },
- "GetAncestryRequest": {
- "properties": {},
- "id": "GetAncestryRequest",
- "description": "The request sent to the\nGetAncestry\nmethod.",
- "type": "object"
- },
- "Project": {
- "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
- "type": "string"
- },
- "projectId": {
- "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.",
- "type": "string"
- },
- "lifecycleState": {
- "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 DeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
- "This lifecycle state is no longer used and is not returned by the API."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED",
- "DELETE_IN_PROGRESS"
- ],
- "description": "The Project lifecycle state.\n\nRead-only.",
- "type": "string"
- },
- "projectNumber": {
- "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
- "format": "int64",
- "type": "string"
- },
- "parent": {
- "$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"
- }
- },
- "id": "Project"
- },
"TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
@@ -863,75 +561,7 @@
}
}
},
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` 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.",
- "The attempted action would violate the max deleted folder depth\nconstraint."
- ],
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "FOLDER_HEIGHT_VIOLATION",
- "MAX_CHILD_FOLDERS_VIOLATION",
- "FOLDER_NAME_UNIQUENESS_VIOLATION",
- "RESOURCE_DELETED",
- "PARENT_DELETED",
- "CYCLE_INTRODUCED_ERROR",
- "FOLDER_BEING_MOVED",
- "FOLDER_TO_DELETE_NON_EMPTY",
- "DELETED_FOLDER_HEIGHT_VIOLATION"
- ],
- "description": "The type of operation error experienced.",
- "type": "string"
- }
- },
- "id": "FolderOperationError"
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object",
- "properties": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32",
- "type": "integer"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- }
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\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"
+ "id": "TestIamPermissionsRequest"
},
"FolderOperation": {
"properties": {
@@ -966,20 +596,392 @@
"description": "Metadata describing a long running folder operation",
"type": "object"
},
- "ResourceId": {
+ "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": {
- "type": {
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are \"project\" and \"organization\".",
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
"type": "string"
},
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "type": "array",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\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"
+ },
+ "FolderOperationError": {
+ "description": "A classification of the Folder Operation error.",
+ "type": "object",
+ "properties": {
+ "errorMessageId": {
+ "enumDescriptions": [
+ "The error type was unrecognized or unspecified.",
+ "The attempted action would violate the max folder depth constraint.",
+ "The attempted action would violate the max child folders constraint.",
+ "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
+ "The resource being moved has been deleted.",
+ "The resource a folder was being added to has been deleted.",
+ "The attempted action would introduce cycle in resource path.",
+ "The attempted action would move a folder that is already being moved.",
+ "The folder the caller is trying to delete contains active resources.",
+ "The attempted action would violate the max deleted folder depth\nconstraint."
+ ],
+ "enum": [
+ "ERROR_TYPE_UNSPECIFIED",
+ "ACTIVE_FOLDER_HEIGHT_VIOLATION",
+ "MAX_CHILD_FOLDERS_VIOLATION",
+ "FOLDER_NAME_UNIQUENESS_VIOLATION",
+ "RESOURCE_DELETED_VIOLATION",
+ "PARENT_DELETED_VIOLATION",
+ "CYCLE_INTRODUCED_VIOLATION",
+ "FOLDER_BEING_MOVED_VIOLATION",
+ "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
+ "DELETED_FOLDER_HEIGHT_VIOLATION"
+ ],
+ "description": "The type of operation error experienced.",
+ "type": "string"
+ }
+ },
+ "id": "FolderOperationError"
+ },
+ "ResourceId": {
+ "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 \"project\" and \"organization\".",
+ "type": "string"
}
},
"id": "ResourceId",
"description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
"type": "object"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ }
+ },
+ "id": "AuditConfig"
+ },
+ "Ancestor": {
+ "properties": {
+ "resourceId": {
+ "$ref": "ResourceId",
+ "description": "Resource id of the ancestor."
+ }
+ },
+ "id": "Ancestor",
+ "description": "Identifying information for a single ancestor of a project.",
+ "type": "object"
+ },
+ "ListOrganizationsResponse": {
+ "description": "The response returned from the `ListOrganizations` 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 list query, possibly paginated.",
+ "type": "array",
+ "items": {
+ "$ref": "Organization"
+ }
+ }
+ },
+ "id": "ListOrganizationsResponse"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding"
+ },
+ "Empty": {
+ "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"
+ },
+ "UndeleteProjectRequest": {
+ "description": "The request sent to the UndeleteProject\nmethod.",
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteProjectRequest"
+ },
+ "Organization": {
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
+ "type": "object",
+ "properties": {
+ "creationTime": {
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "owner": {
+ "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required.",
+ "$ref": "OrganizationOwner"
+ },
+ "name": {
+ "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
+ "type": "string"
+ },
+ "organizationId": {
+ "description": "An immutable id for the Organization that is assigned on creation. This\nshould be omitted when creating a new Organization.\nThis field is read-only.\nThis field is deprecated and will be removed in v1. Use name instead.",
+ "type": "string"
+ },
+ "lifecycleState": {
+ "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"
+ },
+ "displayName": {
+ "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Organization"
+ },
+ "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": {
+ "properties": {
+ "directoryCustomerId": {
+ "description": "The Google for Work customer id used in the Directory API.",
+ "type": "string"
+ }
+ },
+ "id": "OrganizationOwner",
+ "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
+ "type": "object"
+ },
+ "GetAncestryResponse": {
+ "properties": {
+ "ancestor": {
+ "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
+ "type": "array",
+ "items": {
+ "$ref": "Ancestor"
+ }
+ }
+ },
+ "id": "GetAncestryResponse",
+ "description": "Response from the GetAncestry method.",
+ "type": "object"
+ },
+ "ListProjectsResponse": {
+ "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
+ "type": "object",
+ "properties": {
+ "projects": {
+ "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
+ "type": "array",
+ "items": {
+ "$ref": "Project"
+ }
+ },
+ "nextPageToken": {
+ "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
+ "type": "string"
+ }
+ },
+ "id": "ListProjectsResponse"
+ },
+ "AuditLogConfig": {
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "logType": {
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ]
+ }
+ },
+ "id": "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"
+ },
+ "GetAncestryRequest": {
+ "properties": {},
+ "id": "GetAncestryRequest",
+ "description": "The request sent to the\nGetAncestry\nmethod.",
+ "type": "object"
+ },
+ "Project": {
+ "properties": {
+ "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 DeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
+ "This lifecycle state is no longer used and is not returned by the API."
+ ],
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED",
+ "DELETE_IN_PROGRESS"
+ ],
+ "description": "The Project lifecycle state.\n\nRead-only.",
+ "type": "string"
+ },
+ "projectNumber": {
+ "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "parent": {
+ "description": "An optional reference to a parent Resource.\n\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"
+ }
+ },
+ "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"
}
},
"icons": {
@@ -1002,18 +1004,16 @@
}
}
},
- "kind": "discovery#restDescription",
"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",
"batchPath": "batch",
- "revision": "20170503",
+ "revision": "20170524",
"documentationLink": "https://cloud.google.com/resource-manager",
"id": "cloudresourcemanager:v1beta1",
- "title": "Google Cloud Resource Manager API",
- "ownerName": "Google",
- "discoveryVersion": "v1"
+ "title": "Google Cloud Resource Manager API"
}
diff --git a/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go b/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
index be3f8d9..9d3616a 100644
--- a/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
+++ b/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
@@ -310,6 +310,7 @@
// 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
@@ -418,22 +419,23 @@
// Possible values:
// "ERROR_TYPE_UNSPECIFIED" - The error type was unrecognized or
// unspecified.
- // "FOLDER_HEIGHT_VIOLATION" - The attempted action would violate the
- // max folder depth constraint.
+ // "ACTIVE_FOLDER_HEIGHT_VIOLATION" - The attempted action would
+ // violate the max folder depth constraint.
// "MAX_CHILD_FOLDERS_VIOLATION" - The attempted action would violate
// the max child folders constraint.
// "FOLDER_NAME_UNIQUENESS_VIOLATION" - The attempted action would
// violate the locally-unique folder
// display_name constraint.
- // "RESOURCE_DELETED" - The resource being moved has been deleted.
- // "PARENT_DELETED" - The resource a folder was being added to has
- // been deleted.
- // "CYCLE_INTRODUCED_ERROR" - The attempted action would introduce
+ // "RESOURCE_DELETED_VIOLATION" - The resource being moved has been
+ // deleted.
+ // "PARENT_DELETED_VIOLATION" - The resource a folder was being added
+ // to has been deleted.
+ // "CYCLE_INTRODUCED_VIOLATION" - The attempted action would introduce
// cycle in resource path.
- // "FOLDER_BEING_MOVED" - The attempted action would move a folder
- // that is already being moved.
- // "FOLDER_TO_DELETE_NON_EMPTY" - The folder the caller is trying to
- // delete contains active resources.
+ // "FOLDER_BEING_MOVED_VIOLATION" - The attempted action would move a
+ // folder that is already being moved.
+ // "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION" - The folder the caller is
+ // trying to delete contains active resources.
// "DELETED_FOLDER_HEIGHT_VIOLATION" - The attempted action would
// violate the max deleted folder depth
// constraint.
diff --git a/cloudtrace/v1/cloudtrace-api.json b/cloudtrace/v1/cloudtrace-api.json
index edaaf73..24a0fcc 100644
--- a/cloudtrace/v1/cloudtrace-api.json
+++ b/cloudtrace/v1/cloudtrace-api.json
@@ -7,84 +7,37 @@
"ownerName": "Google",
"resources": {
"projects": {
- "methods": {
- "patchTraces": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.append"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/traces",
- "path": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.patchTraces",
- "description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created.",
- "request": {
- "$ref": "Traces"
- }
- }
- },
"resources": {
"traces": {
"methods": {
"list": {
"flatPath": "v1/projects/{projectId}/traces",
- "path": "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.",
- "response": {
- "$ref": "ListTracesResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"projectId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTracesResponse"
+ },
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum number of traces to return. If not specified or \u003c= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size. Optional.",
- "format": "int32",
- "type": "integer"
- },
- "view": {
- "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
- "type": "string",
- "location": "query",
- "enum": [
- "VIEW_TYPE_UNSPECIFIED",
- "MINIMAL",
- "ROOTSPAN",
- "COMPLETE"
- ]
- },
"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",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
"type": "string"
},
- "filter": {
- "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
+ "projectId": {
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "required": true,
"type": "string",
- "location": "query"
+ "location": "path"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
+ "type": "string"
},
"endTime": {
"location": "query",
@@ -92,15 +45,32 @@
"format": "google-datetime",
"type": "string"
},
+ "pageToken": {
+ "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
+ "type": "string",
+ "location": "query"
+ },
"startTime": {
- "location": "query",
"description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
"format": "google-datetime",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
- "pageToken": {
+ "pageSize": {
+ "type": "integer",
"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.",
+ "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"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "VIEW_TYPE_UNSPECIFIED",
+ "MINIMAL",
+ "ROOTSPAN",
+ "COMPLETE"
+ ],
+ "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
"type": "string"
}
},
@@ -110,7 +80,6 @@
]
},
"get": {
- "description": "Gets a single trace by its ID.",
"response": {
"$ref": "Trace"
},
@@ -121,10 +90,10 @@
"httpMethod": "GET",
"parameters": {
"projectId": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "ID of the Cloud project where the trace data is stored."
},
"traceId": {
"location": "path",
@@ -139,18 +108,49 @@
],
"flatPath": "v1/projects/{projectId}/traces/{traceId}",
"path": "v1/projects/{projectId}/traces/{traceId}",
- "id": "cloudtrace.projects.traces.get"
+ "id": "cloudtrace.projects.traces.get",
+ "description": "Gets a single trace by its ID."
}
}
}
+ },
+ "methods": {
+ "patchTraces": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.append"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/traces",
+ "id": "cloudtrace.projects.patchTraces",
+ "path": "v1/projects/{projectId}/traces",
+ "description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created.",
+ "request": {
+ "$ref": "Traces"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ }
+ }
}
}
},
"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.",
- "type": "string"
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"access_token": {
"location": "query",
@@ -158,15 +158,15 @@
"type": "string"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"bearer_token": {
"location": "query",
@@ -174,37 +174,38 @@
"type": "string"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "default": "true"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"$.xgafv": {
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -214,8 +215,7 @@
"1",
"2"
],
- "description": "V1 error format.",
- "type": "string"
+ "description": "V1 error format."
},
"alt": {
"enum": [
@@ -237,91 +237,15 @@
"version": "v1",
"baseUrl": "https://cloudtrace.googleapis.com/",
"kind": "discovery#restDescription",
- "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",
+ "servicePath": "",
"basePath": "",
- "revision": "20170425",
- "id": "cloudtrace:v1",
+ "revision": "20170531",
"documentationLink": "https://cloud.google.com/trace",
+ "id": "cloudtrace:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "TraceSpan": {
- "description": "A span represents a single timed event within a trace. Spans can be nested\nand form a trace tree. Often, a trace contains a root span that describes the\nend-to-end latency of an operation and, optionally, one or more subspans for\nits suboperations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace.",
- "type": "object",
- "properties": {
- "parentSpanId": {
- "description": "ID of the parent span, if any. Optional.",
- "format": "uint64",
- "type": "string"
- },
- "endTime": {
- "description": "End time of the span in nanoseconds from the UNIX epoch.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Start time of the span in nanoseconds from the UNIX epoch.",
- "format": "google-datetime",
- "type": "string"
- },
- "kind": {
- "enumDescriptions": [
- "Unspecified.",
- "Indicates that the span covers server-side handling of an RPC or other\nremote network request.",
- "Indicates that the span covers the client-side wrapper around an RPC or\nother remote request."
- ],
- "enum": [
- "SPAN_KIND_UNSPECIFIED",
- "RPC_SERVER",
- "RPC_CLIENT"
- ],
- "description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`",
- "type": "object"
- },
- "name": {
- "description": "Name of the span. Must be less than 128 bytes. The span name is sanitized\nand displayed in the Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe name may be a method name or some other per-call site name.\nFor the same executable and the same call point, a best practice is\nto use a consistent name, which makes it easier to correlate\ncross-trace spans.",
- "type": "string"
- },
- "spanId": {
- "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.",
- "format": "uint64",
- "type": "string"
- }
- },
- "id": "TraceSpan"
- },
- "ListTracesResponse": {
- "description": "The response message for the `ListTraces` method.",
- "type": "object",
- "properties": {
- "traces": {
- "description": "List of trace records returned.",
- "type": "array",
- "items": {
- "$ref": "Trace"
- }
- },
- "nextPageToken": {
- "description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
- "type": "string"
- }
- },
- "id": "ListTracesResponse"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
"Trace": {
"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",
@@ -345,8 +269,6 @@
"id": "Trace"
},
"Traces": {
- "description": "List of new or updated traces.",
- "type": "object",
"properties": {
"traces": {
"description": "List of traces.",
@@ -356,26 +278,104 @@
}
}
},
- "id": "Traces"
+ "id": "Traces",
+ "description": "List of new or updated traces.",
+ "type": "object"
+ },
+ "TraceSpan": {
+ "description": "A span represents a single timed event within a trace. Spans can be nested\nand form a trace tree. Often, a trace contains a root span that describes the\nend-to-end latency of an operation and, optionally, one or more subspans for\nits suboperations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace.",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Indicates that the span covers server-side handling of an RPC or other\nremote network request.",
+ "Indicates that the span covers the client-side wrapper around an RPC or\nother remote request."
+ ],
+ "enum": [
+ "SPAN_KIND_UNSPECIFIED",
+ "RPC_SERVER",
+ "RPC_CLIENT"
+ ],
+ "description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`",
+ "type": "object"
+ },
+ "name": {
+ "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."
+ },
+ "spanId": {
+ "type": "string",
+ "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.",
+ "format": "uint64"
+ },
+ "parentSpanId": {
+ "type": "string",
+ "description": "ID of the parent span, if any. Optional.",
+ "format": "uint64"
+ },
+ "endTime": {
+ "description": "End time of the span in nanoseconds from the UNIX epoch.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start time of the span in nanoseconds from the UNIX epoch.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "TraceSpan"
+ },
+ "ListTracesResponse": {
+ "type": "object",
+ "properties": {
+ "traces": {
+ "description": "List of trace records returned.",
+ "type": "array",
+ "items": {
+ "$ref": "Trace"
+ }
+ },
+ "nextPageToken": {
+ "description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
+ "type": "string"
+ }
+ },
+ "id": "ListTracesResponse",
+ "description": "The response message for the `ListTraces` method."
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
}
},
- "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"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"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
}
}
}
diff --git a/clouduseraccounts/v0.alpha/clouduseraccounts-api.json b/clouduseraccounts/v0.alpha/clouduseraccounts-api.json
index d5b3fd9..2ef43ad 100644
--- a/clouduseraccounts/v0.alpha/clouduseraccounts-api.json
+++ b/clouduseraccounts/v0.alpha/clouduseraccounts-api.json
@@ -1,13 +1,1853 @@
{
- "error": {
- "errors": [
- {
- "domain": "global",
- "reason": "backendError",
- "message": "Backend Error"
+ "kind": "discovery#restDescription",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/lOQeocShB0dxGwrtxzB56jZ95Xk\"",
+ "discoveryVersion": "v1",
+ "id": "clouduseraccounts:alpha",
+ "name": "clouduseraccounts",
+ "canonicalName": "Cloud User Accounts",
+ "version": "alpha",
+ "revision": "20160316",
+ "title": "Cloud User Accounts API",
+ "description": "Creates and manages users and groups for accessing Google Compute Engine virtual machines.",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
+ "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
+ },
+ "documentationLink": "https://cloud.google.com/compute/docs/access/user-accounts/api/latest/",
+ "protocol": "rest",
+ "baseUrl": "https://www.googleapis.com/clouduseraccounts/alpha/projects/",
+ "basePath": "/clouduseraccounts/alpha/projects/",
+ "rootUrl": "https://www.googleapis.com/",
+ "servicePath": "clouduseraccounts/alpha/projects/",
+ "batchPath": "batch",
+ "parameters": {
+ "alt": {
+ "type": "string",
+ "description": "Data format for the response.",
+ "default": "json",
+ "enum": [
+ "json"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json"
+ ],
+ "location": "query"
+ },
+ "fields": {
+ "type": "string",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query"
+ },
+ "key": {
+ "type": "string",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query"
+ },
+ "oauth_token": {
+ "type": "string",
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "type": "boolean",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "location": "query"
+ },
+ "quotaUser": {
+ "type": "string",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
+ "location": "query"
+ },
+ "userIp": {
+ "type": "string",
+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
+ "location": "query"
+ }
+ },
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud.useraccounts": {
+ "description": "Manage your Google Cloud User Accounts"
+ },
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly": {
+ "description": "View your Google Cloud User Accounts"
+ }
}
- ],
- "code": 503,
- "message": "Backend Error"
+ }
+ },
+ "schemas": {
+ "AuditConfig": {
+ "id": "AuditConfig",
+ "type": "object",
+ "description": "Enables \"data access\" audit logging for a service and specifies a list of members that are log-exempted.",
+ "properties": {
+ "exemptedMembers": {
+ "type": "array",
+ "description": "Specifies the identities that are exempted from \"data access\" audit logging for the `service` specified above. Follows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "service": {
+ "type": "string",
+ "description": "Specifies a service that will be enabled for \"data access\" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services."
+ }
+ }
+ },
+ "AuthorizedKeysView": {
+ "id": "AuthorizedKeysView",
+ "type": "object",
+ "description": "A list of authorized public keys for a user account.",
+ "properties": {
+ "keys": {
+ "type": "array",
+ "description": "[Output Only] The list of authorized public keys in SSH format.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "sudoer": {
+ "type": "boolean",
+ "description": "[Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys."
+ }
+ }
+ },
+ "Binding": {
+ "id": "Binding",
+ "type": "object",
+ "description": "Associates `members` with a `role`.",
+ "properties": {
+ "members": {
+ "type": "array",
+ "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "type": "string",
+ "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`."
+ }
+ }
+ },
+ "Condition": {
+ "id": "Condition",
+ "type": "object",
+ "description": "A condition to be met.",
+ "properties": {
+ "iam": {
+ "type": "string",
+ "description": "Trusted attributes supplied by the IAM system.",
+ "enum": [
+ "ATTRIBUTION",
+ "AUTHORITY",
+ "NO_ATTR"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ },
+ "op": {
+ "type": "string",
+ "description": "An operator to apply the subject with.",
+ "enum": [
+ "DISCHARGED",
+ "EQUALS",
+ "IN",
+ "NOT_EQUALS",
+ "NOT_IN",
+ "NO_OP"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
+ "svc": {
+ "type": "string",
+ "description": "Trusted attributes discharged by the service."
+ },
+ "sys": {
+ "type": "string",
+ "description": "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.",
+ "enum": [
+ "IP",
+ "NAME",
+ "NO_ATTR",
+ "REGION",
+ "SERVICE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "The object of the condition. Exactly one of these must be set."
+ },
+ "values": {
+ "type": "array",
+ "description": "The objects of the condition. This is mutually exclusive with 'value'.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "Group": {
+ "id": "Group",
+ "type": "object",
+ "description": "A Group resource.",
+ "properties": {
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional textual description of the resource; provided by the client when the resource is created."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "format": "uint64"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always clouduseraccounts#group for groups.",
+ "default": "clouduseraccounts#group"
+ },
+ "members": {
+ "type": "array",
+ "description": "[Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the resource; provided by the client when the resource is created.",
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "annotations": {
+ "required": [
+ "clouduseraccounts.groups.insert"
+ ]
+ }
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server defined URL for the resource."
+ }
+ }
+ },
+ "GroupList": {
+ "id": "GroupList",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "type": "array",
+ "description": "[Output Only] A list of Group resources.",
+ "items": {
+ "$ref": "Group"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.",
+ "default": "clouduseraccounts#groupList"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] A token used to continue a truncated list request."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server defined URL for this resource."
+ }
+ }
+ },
+ "GroupsAddMemberRequest": {
+ "id": "GroupsAddMemberRequest",
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "Fully-qualified URLs of the User resources to add.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "GroupsRemoveMemberRequest": {
+ "id": "GroupsRemoveMemberRequest",
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "Fully-qualified URLs of the User resources to remove.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "LinuxAccountViews": {
+ "id": "LinuxAccountViews",
+ "type": "object",
+ "description": "A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API.",
+ "properties": {
+ "groupViews": {
+ "type": "array",
+ "description": "[Output Only] A list of all groups within a project.",
+ "items": {
+ "$ref": "LinuxGroupView"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.",
+ "default": "clouduseraccounts#linuxAccountViews"
+ },
+ "userViews": {
+ "type": "array",
+ "description": "[Output Only] A list of all users within a project.",
+ "items": {
+ "$ref": "LinuxUserView"
+ }
+ }
+ }
+ },
+ "LinuxGetAuthorizedKeysViewResponse": {
+ "id": "LinuxGetAuthorizedKeysViewResponse",
+ "type": "object",
+ "properties": {
+ "resource": {
+ "$ref": "AuthorizedKeysView",
+ "description": "[Output Only] A list of authorized public keys for a user."
+ }
+ }
+ },
+ "LinuxGetLinuxAccountViewsResponse": {
+ "id": "LinuxGetLinuxAccountViewsResponse",
+ "type": "object",
+ "properties": {
+ "resource": {
+ "$ref": "LinuxAccountViews",
+ "description": "[Output Only] A list of authorized user accounts and groups."
+ }
+ }
+ },
+ "LinuxGroupView": {
+ "id": "LinuxGroupView",
+ "type": "object",
+ "description": "A detailed view of a Linux group.",
+ "properties": {
+ "gid": {
+ "type": "integer",
+ "description": "[Output Only] The Group ID.",
+ "format": "uint32"
+ },
+ "groupName": {
+ "type": "string",
+ "description": "[Output Only] Group name."
+ },
+ "members": {
+ "type": "array",
+ "description": "[Output Only] List of user accounts that belong to the group.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "LinuxUserView": {
+ "id": "LinuxUserView",
+ "type": "object",
+ "description": "A detailed view of a Linux user account.",
+ "properties": {
+ "gecos": {
+ "type": "string",
+ "description": "[Output Only] The GECOS (user information) entry for this account."
+ },
+ "gid": {
+ "type": "integer",
+ "description": "[Output Only] User's default group ID.",
+ "format": "uint32"
+ },
+ "homeDirectory": {
+ "type": "string",
+ "description": "[Output Only] The path to the home directory for this account."
+ },
+ "shell": {
+ "type": "string",
+ "description": "[Output Only] The path to the login shell for this account."
+ },
+ "uid": {
+ "type": "integer",
+ "description": "[Output Only] User ID.",
+ "format": "uint32"
+ },
+ "username": {
+ "type": "string",
+ "description": "[Output Only] The username of the account."
+ }
+ }
+ },
+ "LogConfig": {
+ "id": "LogConfig",
+ "type": "object",
+ "description": "Specifies what kind of log the caller must write",
+ "properties": {
+ "counter": {
+ "$ref": "LogConfigCounterOptions",
+ "description": "Counter options."
+ }
+ }
+ },
+ "LogConfigCounterOptions": {
+ "id": "LogConfigCounterOptions",
+ "type": "object",
+ "description": "Options for counters",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "The field value to attribute."
+ },
+ "metric": {
+ "type": "string",
+ "description": "The metric to update."
+ }
+ }
+ },
+ "Operation": {
+ "id": "Operation",
+ "type": "object",
+ "description": "An Operation resource, used to manage asynchronous API requests.",
+ "properties": {
+ "clientOperationId": {
+ "type": "string",
+ "description": "[Output Only] Reserved for future use."
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "description": {
+ "type": "string",
+ "description": "[Output Only] A textual description of the operation, which is set when the operation is created."
+ },
+ "endTime": {
+ "type": "string",
+ "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format."
+ },
+ "error": {
+ "type": "object",
+ "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
+ "properties": {
+ "errors": {
+ "type": "array",
+ "description": "[Output Only] The array of errors encountered while processing this operation.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "[Output Only] The error type identifier for this error."
+ },
+ "location": {
+ "type": "string",
+ "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional."
+ },
+ "message": {
+ "type": "string",
+ "description": "[Output Only] An optional, human-readable error message."
+ }
+ }
+ }
+ }
+ }
+ },
+ "httpErrorMessage": {
+ "type": "string",
+ "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND."
+ },
+ "httpErrorStatusCode": {
+ "type": "integer",
+ "description": "[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.",
+ "format": "int32"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "insertTime": {
+ "type": "string",
+ "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format."
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.",
+ "default": "clouduseraccounts#operation"
+ },
+ "name": {
+ "type": "string",
+ "description": "[Output Only] Name of the resource."
+ },
+ "operationType": {
+ "type": "string",
+ "description": "[Output Only] The type of operation, such as insert, update, or delete, and so on."
+ },
+ "progress": {
+ "type": "integer",
+ "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.",
+ "format": "int32"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "startTime": {
+ "type": "string",
+ "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format."
+ },
+ "status": {
+ "type": "string",
+ "description": "[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.",
+ "enum": [
+ "DONE",
+ "PENDING",
+ "RUNNING"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ },
+ "statusMessage": {
+ "type": "string",
+ "description": "[Output Only] An optional textual description of the current status of the operation."
+ },
+ "targetId": {
+ "type": "string",
+ "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.",
+ "format": "uint64"
+ },
+ "targetLink": {
+ "type": "string",
+ "description": "[Output Only] The URL of the resource that the operation modifies."
+ },
+ "user": {
+ "type": "string",
+ "description": "[Output Only] User who requested the operation, for example: user@example.com."
+ },
+ "warnings": {
+ "type": "array",
+ "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "INJECTED_KERNELS_DEPRECATED",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_NOT_DELETED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
+ },
+ "message": {
+ "type": "string",
+ "description": "[Output Only] A human-readable description of the warning code."
+ }
+ }
+ }
+ },
+ "zone": {
+ "type": "string",
+ "description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations."
+ }
+ }
+ },
+ "OperationList": {
+ "id": "OperationList",
+ "type": "object",
+ "description": "Contains a list of Operation resources.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "items": {
+ "type": "array",
+ "description": "[Output Only] A list of Operation resources.",
+ "items": {
+ "$ref": "Operation"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#operations for Operations resource.",
+ "default": "clouduseraccounts#operationList"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ }
+ },
+ "Policy": {
+ "id": "Policy",
+ "type": "object",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.\n\n\n\nA `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.\n\n**Example**\n\n{ \"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\"] } ] }\n\nFor a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).",
+ "properties": {
+ "auditConfigs": {
+ "type": "array",
+ "description": "Specifies audit logging configs for \"data access\". \"data access\": generally refers to data reads/writes and admin reads. \"admin activity\": generally refers to admin writes.\n\nNote: `AuditConfig` doesn't apply to \"admin activity\", which always enables audit logging.",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
+ "bindings": {
+ "type": "array",
+ "description": "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.",
+ "items": {
+ "$ref": "Binding"
+ }
+ },
+ "etag": {
+ "type": "string",
+ "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.",
+ "format": "byte"
+ },
+ "iamOwned": {
+ "type": "boolean",
+ "description": ""
+ },
+ "rules": {
+ "type": "array",
+ "description": "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.",
+ "items": {
+ "$ref": "Rule"
+ }
+ },
+ "version": {
+ "type": "integer",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32"
+ }
+ }
+ },
+ "PublicKey": {
+ "id": "PublicKey",
+ "type": "object",
+ "description": "A public key for authenticating to guests.",
+ "properties": {
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional textual description of the resource; provided by the client when the resource is created."
+ },
+ "expirationTimestamp": {
+ "type": "string",
+ "description": "Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires."
+ },
+ "fingerprint": {
+ "type": "string",
+ "description": "[Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key."
+ },
+ "key": {
+ "type": "string",
+ "description": "Public key text in SSH format, defined by RFC4253 section 6.6."
+ }
+ }
+ },
+ "Rule": {
+ "id": "Rule",
+ "type": "object",
+ "description": "A rule to be applied in a Policy.",
+ "properties": {
+ "action": {
+ "type": "string",
+ "description": "Required",
+ "enum": [
+ "ALLOW",
+ "ALLOW_WITH_LOG",
+ "DENY",
+ "DENY_WITH_LOG",
+ "LOG",
+ "NO_ACTION"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
+ "conditions": {
+ "type": "array",
+ "description": "Additional restrictions that must be met",
+ "items": {
+ "$ref": "Condition"
+ }
+ },
+ "description": {
+ "type": "string",
+ "description": "Human-readable description of the rule."
+ },
+ "ins": {
+ "type": "array",
+ "description": "The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "logConfigs": {
+ "type": "array",
+ "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.",
+ "items": {
+ "$ref": "LogConfig"
+ }
+ },
+ "notIns": {
+ "type": "array",
+ "description": "The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "permissions": {
+ "type": "array",
+ "description": "A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "TestPermissionsRequest": {
+ "id": "TestPermissionsRequest",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "type": "array",
+ "description": "The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "TestPermissionsResponse": {
+ "id": "TestPermissionsResponse",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "type": "array",
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "User": {
+ "id": "User",
+ "type": "object",
+ "description": "A User resource.",
+ "properties": {
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional textual description of the resource; provided by the client when the resource is created."
+ },
+ "groups": {
+ "type": "array",
+ "description": "[Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "format": "uint64"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always clouduseraccounts#user for users.",
+ "default": "clouduseraccounts#user"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the resource; provided by the client when the resource is created.",
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "annotations": {
+ "required": [
+ "clouduseraccounts.users.insert"
+ ]
+ }
+ },
+ "owner": {
+ "type": "string",
+ "description": "Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.",
+ "annotations": {
+ "required": [
+ "clouduseraccounts.users.insert"
+ ]
+ }
+ },
+ "publicKeys": {
+ "type": "array",
+ "description": "[Output Only] Public keys that this user may use to login.",
+ "items": {
+ "$ref": "PublicKey"
+ }
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server defined URL for the resource."
+ }
+ }
+ },
+ "UserList": {
+ "id": "UserList",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "type": "array",
+ "description": "[Output Only] A list of User resources.",
+ "items": {
+ "$ref": "User"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.",
+ "default": "clouduseraccounts#userList"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] A token used to continue a truncated list request."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server defined URL for this resource."
+ }
+ }
+ }
+ },
+ "resources": {
+ "globalAccountsOperations": {
+ "methods": {
+ "delete": {
+ "id": "clouduseraccounts.globalAccountsOperations.delete",
+ "path": "{project}/global/operations/{operation}",
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified operation resource.",
+ "parameters": {
+ "operation": {
+ "type": "string",
+ "description": "Name of the Operations resource to delete.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "operation"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud.useraccounts"
+ ]
+ },
+ "get": {
+ "id": "clouduseraccounts.globalAccountsOperations.get",
+ "path": "{project}/global/operations/{operation}",
+ "httpMethod": "GET",
+ "description": "Retrieves the specified operation resource.",
+ "parameters": {
+ "operation": {
+ "type": "string",
+ "description": "Name of the Operations resource to return.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "operation"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ },
+ "list": {
+ "id": "clouduseraccounts.globalAccountsOperations.list",
+ "path": "{project}/global/operations",
+ "httpMethod": "GET",
+ "description": "Retrieves the list of operation resources contained within the specified project.",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
+ "location": "query"
+ },
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "maximum": "500",
+ "location": "query"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "OperationList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ }
+ }
+ },
+ "groups": {
+ "methods": {
+ "addMember": {
+ "id": "clouduseraccounts.groups.addMember",
+ "path": "{project}/global/groups/{groupName}/addMember",
+ "httpMethod": "POST",
+ "description": "Adds users to the specified group.",
+ "parameters": {
+ "groupName": {
+ "type": "string",
+ "description": "Name of the group for this request.",
+ "required": true,
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "groupName"
+ ],
+ "request": {
+ "$ref": "GroupsAddMemberRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud.useraccounts"
+ ]
+ },
+ "delete": {
+ "id": "clouduseraccounts.groups.delete",
+ "path": "{project}/global/groups/{groupName}",
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified Group resource.",
+ "parameters": {
+ "groupName": {
+ "type": "string",
+ "description": "Name of the Group resource to delete.",
+ "required": true,
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "groupName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud.useraccounts"
+ ]
+ },
+ "get": {
+ "id": "clouduseraccounts.groups.get",
+ "path": "{project}/global/groups/{groupName}",
+ "httpMethod": "GET",
+ "description": "Returns the specified Group resource.",
+ "parameters": {
+ "groupName": {
+ "type": "string",
+ "description": "Name of the Group resource to return.",
+ "required": true,
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "groupName"
+ ],
+ "response": {
+ "$ref": "Group"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ },
+ "getIamPolicy": {
+ "id": "clouduseraccounts.groups.getIamPolicy",
+ "path": "{project}/global/groups/{resource}/getIamPolicy",
+ "httpMethod": "GET",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ },
+ "insert": {
+ "id": "clouduseraccounts.groups.insert",
+ "path": "{project}/global/groups",
+ "httpMethod": "POST",
+ "description": "Creates a Group resource in the specified project using the data included in the request.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "request": {
+ "$ref": "Group"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud.useraccounts"
+ ]
+ },
+ "list": {
+ "id": "clouduseraccounts.groups.list",
+ "path": "{project}/global/groups",
+ "httpMethod": "GET",
+ "description": "Retrieves the list of groups contained within the specified project.",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
+ "location": "query"
+ },
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "maximum": "500",
+ "location": "query"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "GroupList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ },
+ "removeMember": {
+ "id": "clouduseraccounts.groups.removeMember",
+ "path": "{project}/global/groups/{groupName}/removeMember",
+ "httpMethod": "POST",
+ "description": "Removes users from the specified group.",
+ "parameters": {
+ "groupName": {
+ "type": "string",
+ "description": "Name of the group for this request.",
+ "required": true,
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "groupName"
+ ],
+ "request": {
+ "$ref": "GroupsRemoveMemberRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud.useraccounts"
+ ]
+ },
+ "setIamPolicy": {
+ "id": "clouduseraccounts.groups.setIamPolicy",
+ "path": "{project}/global/groups/{resource}/setIamPolicy",
+ "httpMethod": "POST",
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "Policy"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ },
+ "testIamPermissions": {
+ "id": "clouduseraccounts.groups.testIamPermissions",
+ "path": "{project}/global/groups/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ }
+ }
+ },
+ "linux": {
+ "methods": {
+ "getAuthorizedKeysView": {
+ "id": "clouduseraccounts.linux.getAuthorizedKeysView",
+ "path": "{project}/zones/{zone}/authorizedKeysView/{user}",
+ "httpMethod": "POST",
+ "description": "Returns a list of authorized public keys for a specific user account.",
+ "parameters": {
+ "instance": {
+ "type": "string",
+ "description": "The fully-qualified URL of the virtual machine requesting the view.",
+ "required": true,
+ "location": "query"
+ },
+ "login": {
+ "type": "boolean",
+ "description": "Whether the view was requested as part of a user-initiated login.",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "user": {
+ "type": "string",
+ "description": "The user account for which you want to get a list of authorized public keys.",
+ "required": true,
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "Name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "user",
+ "instance"
+ ],
+ "response": {
+ "$ref": "LinuxGetAuthorizedKeysViewResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ },
+ "getLinuxAccountViews": {
+ "id": "clouduseraccounts.linux.getLinuxAccountViews",
+ "path": "{project}/zones/{zone}/linuxAccountViews",
+ "httpMethod": "POST",
+ "description": "Retrieves a list of user accounts for an instance within a specific project.",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
+ "location": "query"
+ },
+ "instance": {
+ "type": "string",
+ "description": "The fully-qualified URL of the virtual machine requesting the views.",
+ "required": true,
+ "location": "query"
+ },
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "maximum": "500",
+ "location": "query"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "Name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "response": {
+ "$ref": "LinuxGetLinuxAccountViewsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ }
+ }
+ },
+ "users": {
+ "methods": {
+ "addPublicKey": {
+ "id": "clouduseraccounts.users.addPublicKey",
+ "path": "{project}/global/users/{user}/addPublicKey",
+ "httpMethod": "POST",
+ "description": "Adds a public key to the specified User resource with the data included in the request.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "user": {
+ "type": "string",
+ "description": "Name of the user for this request.",
+ "required": true,
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "user"
+ ],
+ "request": {
+ "$ref": "PublicKey"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud.useraccounts"
+ ]
+ },
+ "delete": {
+ "id": "clouduseraccounts.users.delete",
+ "path": "{project}/global/users/{user}",
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified User resource.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "user": {
+ "type": "string",
+ "description": "Name of the user resource to delete.",
+ "required": true,
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "user"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud.useraccounts"
+ ]
+ },
+ "get": {
+ "id": "clouduseraccounts.users.get",
+ "path": "{project}/global/users/{user}",
+ "httpMethod": "GET",
+ "description": "Returns the specified User resource.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "user": {
+ "type": "string",
+ "description": "Name of the user resource to return.",
+ "required": true,
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "user"
+ ],
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ },
+ "getIamPolicy": {
+ "id": "clouduseraccounts.users.getIamPolicy",
+ "path": "{project}/global/users/{resource}/getIamPolicy",
+ "httpMethod": "GET",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ },
+ "insert": {
+ "id": "clouduseraccounts.users.insert",
+ "path": "{project}/global/users",
+ "httpMethod": "POST",
+ "description": "Creates a User resource in the specified project using the data included in the request.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "request": {
+ "$ref": "User"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud.useraccounts"
+ ]
+ },
+ "list": {
+ "id": "clouduseraccounts.users.list",
+ "path": "{project}/global/users",
+ "httpMethod": "GET",
+ "description": "Retrieves a list of users contained within the specified project.",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
+ "location": "query"
+ },
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "maximum": "500",
+ "location": "query"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "UserList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ },
+ "removePublicKey": {
+ "id": "clouduseraccounts.users.removePublicKey",
+ "path": "{project}/global/users/{user}/removePublicKey",
+ "httpMethod": "POST",
+ "description": "Removes the specified public key from the user.",
+ "parameters": {
+ "fingerprint": {
+ "type": "string",
+ "description": "The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.",
+ "required": true,
+ "pattern": "[a-f0-9]{32}",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "user": {
+ "type": "string",
+ "description": "Name of the user for this request.",
+ "required": true,
+ "pattern": "[a-z][-a-z0-9_]{0,31}",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "user",
+ "fingerprint"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud.useraccounts"
+ ]
+ },
+ "setIamPolicy": {
+ "id": "clouduseraccounts.users.setIamPolicy",
+ "path": "{project}/global/users/{resource}/setIamPolicy",
+ "httpMethod": "POST",
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "Policy"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ },
+ "testIamPermissions": {
+ "id": "clouduseraccounts.users.testIamPermissions",
+ "path": "{project}/global/users/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/cloud.useraccounts",
+ "https://www.googleapis.com/auth/cloud.useraccounts.readonly"
+ ]
+ }
+ }
+ }
}
}
diff --git a/compute/v0.alpha/compute-api.json b/compute/v0.alpha/compute-api.json
index 4b81808..396152c 100644
--- a/compute/v0.alpha/compute-api.json
+++ b/compute/v0.alpha/compute-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/f4tLWRGm0VyTLgvj6ukIiR_6ps8\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/FsCsX2uK2X7VSrMElCYth0LryG8\"",
"discoveryVersion": "v1",
"id": "compute:alpha",
"name": "compute",
"version": "alpha",
- "revision": "20170423",
+ "revision": "20170530",
"title": "Compute Engine API",
"description": "Creates and runs virtual machines on Google Cloud Platform.",
"ownerDomain": "google.com",
@@ -1751,7 +1751,7 @@
"properties": {
"members": {
"type": "array",
- "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
+ "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
"items": {
"type": "string"
}
@@ -1811,7 +1811,7 @@
"Commitment": {
"id": "Commitment",
"type": "object",
- "description": "A usage-commitment with a start / end time. Users create commitments for particular resources (e.g. memory). Actual usage is first deducted from available commitments made prior, perhaps at a reduced price (as laid out in the commitment).",
+ "description": "Represents a Commitment resource. Creating a Commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.\n\nCommitted use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts.",
"properties": {
"creationTimestamp": {
"type": "string",
@@ -1875,7 +1875,7 @@
},
"status": {
"type": "string",
- "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end-date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.",
+ "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.",
"enum": [
"ACTIVE",
"CREATING",
@@ -2951,7 +2951,7 @@
"properties": {
"IPAddress": {
"type": "string",
- "description": "The IP address that this forwarding rule is serving on behalf of.\n\nFor global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.\n\nWhen the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. Only IPv4 is supported."
+ "description": "The IP address that this forwarding rule is serving on behalf of.\n\nFor global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6.\n\nWhen the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule."
},
"IPProtocol": {
"type": "string",
@@ -5567,7 +5567,7 @@
"properties": {
"canIpForward": {
"type": "boolean",
- "description": "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information."
+ "description": "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information."
},
"description": {
"type": "string",
@@ -5933,7 +5933,7 @@
"Interconnect": {
"id": "Interconnect",
"type": "object",
- "description": "Protocol definitions for Mixer API to support Interconnect. Next available tag: 20",
+ "description": "Protocol definitions for Mixer API to support Interconnect. Next available tag: 21",
"properties": {
"adminEnabled": {
"type": "boolean",
@@ -6316,6 +6316,32 @@
"type": "string",
"description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character."
},
+ "availabilityZone": {
+ "type": "string",
+ "description": "Availability zone for this location. Within a city, maintenance will not be simultaneously scheduled in more than one availability zone. Example: \"zone1\" or \"zone2\"."
+ },
+ "city": {
+ "type": "string",
+ "description": "City designator used by the Interconnect UI to locate this InterconnectLocation within the Continent. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\"."
+ },
+ "continent": {
+ "type": "string",
+ "description": "Continent for this location. Used by the location picker in the Interconnect UI.",
+ "enum": [
+ "C_AFRICA",
+ "C_ASIA_PAC",
+ "C_EUROPE",
+ "C_NORTH_AMERICA",
+ "C_SOUTH_AMERICA"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
@@ -6523,12 +6549,37 @@
"type": "object",
"description": "Specifies what kind of log the caller must write",
"properties": {
+ "cloudAudit": {
+ "$ref": "LogConfigCloudAuditOptions",
+ "description": "Cloud audit options."
+ },
"counter": {
"$ref": "LogConfigCounterOptions",
"description": "Counter options."
}
}
},
+ "LogConfigCloudAuditOptions": {
+ "id": "LogConfigCloudAuditOptions",
+ "type": "object",
+ "description": "Write a Cloud Audit log",
+ "properties": {
+ "logName": {
+ "type": "string",
+ "description": "The log_name to populate in the Cloud Audit Record.",
+ "enum": [
+ "ADMIN_ACTIVITY",
+ "DATA_ACCESS",
+ "UNSPECIFIED_LOG_NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ },
"LogConfigCounterOptions": {
"id": "LogConfigCounterOptions",
"type": "object",
@@ -6825,6 +6876,10 @@
"$ref": "ManagedInstanceLastAttempt",
"description": "[Output Only] Information about the last attempt to create or delete the instance."
},
+ "override": {
+ "$ref": "ManagedInstanceOverride",
+ "description": "[Output Only] Override defined for this instance."
+ },
"standbyMode": {
"type": "string",
"description": "[Output Only] Standby mode of the instance. This field is non-empty iff the instance is a standby.",
@@ -6878,6 +6933,50 @@
}
}
},
+ "ManagedInstanceOverride": {
+ "id": "ManagedInstanceOverride",
+ "type": "object",
+ "description": "Overrides of stateful properties for a given instance",
+ "properties": {
+ "disks": {
+ "type": "array",
+ "description": "The disk overrides defined for this instance",
+ "items": {
+ "$ref": "ManagedInstanceOverrideDiskOverride"
+ }
+ },
+ "instance": {
+ "type": "string",
+ "description": "The URL of the instance."
+ }
+ }
+ },
+ "ManagedInstanceOverrideDiskOverride": {
+ "id": "ManagedInstanceOverrideDiskOverride",
+ "type": "object",
+ "properties": {
+ "deviceName": {
+ "type": "string",
+ "description": "The name of the device on the VM"
+ },
+ "mode": {
+ "type": "string",
+ "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.",
+ "enum": [
+ "READ_ONLY",
+ "READ_WRITE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ },
+ "source": {
+ "type": "string",
+ "description": "The disk that is/will be mounted"
+ }
+ }
+ },
"ManagedInstanceVersion": {
"id": "ManagedInstanceVersion",
"type": "object",
@@ -7792,6 +7891,7 @@
"type": "string",
"description": "[Output Only] Name of the quota metric.",
"enum": [
+ "AMD_S9300_GPUS",
"AUTOSCALERS",
"BACKEND_BUCKETS",
"BACKEND_SERVICES",
@@ -7869,6 +7969,7 @@
"",
"",
"",
+ "",
""
]
},
@@ -8323,12 +8424,12 @@
"properties": {
"amount": {
"type": "string",
- "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes).",
+ "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.",
"format": "int64"
},
"type": {
"type": "string",
- "description": "Type of resource for which this commitment applies.",
+ "description": "Type of resource for which this commitment applies. Possible values are VCPU and MEMORY",
"enum": [
"LOCAL_SSD",
"MEMORY",
@@ -9272,8 +9373,8 @@
},
"priority": {
"type": "integer",
- "description": "An integer indicating the priority of a rule in the list. Rules are evaluated in the increasing order of priority.",
- "format": "uint32"
+ "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated in the increasing order of priority.",
+ "format": "int32"
}
}
},
@@ -9579,11 +9680,11 @@
},
"description": {
"type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
+ "description": "An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time."
},
"gatewayAddress": {
"type": "string",
- "description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork."
+ "description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time."
},
"id": {
"type": "string",
@@ -9592,7 +9693,7 @@
},
"ipCidrRange": {
"type": "string",
- "description": "The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported."
+ "description": "The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time."
},
"kind": {
"type": "string",
@@ -9606,15 +9707,15 @@
},
"network": {
"type": "string",
- "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks."
+ "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time."
},
"privateIpGoogleAccess": {
"type": "boolean",
- "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses."
+ "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess."
},
"region": {
"type": "string",
- "description": "URL of the region where the Subnetwork resides."
+ "description": "URL of the region where the Subnetwork resides. This field can be set only at resource creation time."
},
"secondaryIpRanges": {
"type": "array",
@@ -17353,7 +17454,7 @@
"id": "compute.instanceGroupManagers.abandonInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -17493,7 +17594,7 @@
"id": "compute.instanceGroupManagers.deleteInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -17580,7 +17681,7 @@
"id": "compute.instanceGroupManagers.insert",
"path": "{project}/zones/{zone}/instanceGroupManagers",
"httpMethod": "POST",
- "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group.",
+ "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.",
"parameters": {
"project": {
"type": "string",
@@ -17783,7 +17884,7 @@
"id": "compute.instanceGroupManagers.recreateInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -17830,7 +17931,7 @@
"id": "compute.instanceGroupManagers.resize",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
"httpMethod": "POST",
- "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -17882,7 +17983,7 @@
"id": "compute.instanceGroupManagers.resizeAdvanced",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced",
"httpMethod": "POST",
- "description": "Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.\n\nIf you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.",
+ "description": "Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.\n\nIf you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -18508,7 +18609,7 @@
"id": "compute.instanceGroups.removeInstances",
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
"httpMethod": "POST",
- "description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
+ "description": "Removes one or more instances from the specified instance group, but does not delete those instances.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.",
"parameters": {
"instanceGroup": {
"type": "string",
@@ -21093,6 +21194,44 @@
},
"licenses": {
"methods": {
+ "delete": {
+ "id": "compute.licenses.delete",
+ "path": "{project}/global/licenses/{license}",
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified license.",
+ "parameters": {
+ "license": {
+ "type": "string",
+ "description": "Name of the license resource to delete.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "license"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
"get": {
"id": "compute.licenses.get",
"path": "{project}/global/licenses/{license}",
@@ -22929,7 +23068,7 @@
"id": "compute.regionCommitments.insert",
"path": "{project}/regions/{region}/commitments",
"httpMethod": "POST",
- "description": "Creates an commitment in the specified project using the data included in the request.",
+ "description": "Creates a commitment in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
@@ -22947,7 +23086,7 @@
},
"requestId": {
"type": "string",
- "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
+ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and then the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.",
"location": "query"
}
},
@@ -23569,7 +23708,7 @@
"id": "compute.regionInstanceGroupManagers.abandonInstances",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -23660,7 +23799,7 @@
"id": "compute.regionInstanceGroupManagers.deleteInstances",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -23950,7 +24089,7 @@
"id": "compute.regionInstanceGroupManagers.recreateInstances",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -23997,7 +24136,7 @@
"id": "compute.regionInstanceGroupManagers.resize",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize",
"httpMethod": "POST",
- "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
"parameters": {
"instanceGroupManager": {
"type": "string",
diff --git a/compute/v0.alpha/compute-gen.go b/compute/v0.alpha/compute-gen.go
index 5f68c83..abe7717 100644
--- a/compute/v0.alpha/compute-gen.go
+++ b/compute/v0.alpha/compute-gen.go
@@ -3461,6 +3461,8 @@
// * `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"`
@@ -3575,10 +3577,16 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Commitment: A usage-commitment with a start / end time. Users create
-// commitments for particular resources (e.g. memory). Actual usage is
-// first deducted from available commitments made prior, perhaps at a
-// reduced price (as laid out in the commitment).
+// Commitment: Represents a Commitment resource. Creating a Commitment
+// resource means that you are purchasing a committed use contract with
+// an explicit start and end time. You can create commitments based on
+// vCPUs and memory usage and receive discounted rates. For full
+// details, read Signing Up for Committed Use Discounts.
+//
+// Committed use discounts are subject to Google Cloud Platform's
+// Service Specific Terms. By purchasing a committed use discount, you
+// agree to these terms. Committed use discounts will not renew, so you
+// must purchase a new commitment to continue receiving discounts.
type Commitment struct {
// CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
// format.
@@ -3635,7 +3643,7 @@
StartTimestamp string `json:"startTimestamp,omitempty"`
// Status: [Output Only] Status of the commitment with regards to
- // eventual expiration (each commitment has an end-date defined). One of
+ // eventual expiration (each commitment has an end date defined). One of
// the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
//
// Possible values:
@@ -5339,15 +5347,16 @@
// For global forwarding rules, the address must be a global IP. For
// regional forwarding rules, the address must live in the same region
// as the forwarding rule. By default, this field is empty and an
- // ephemeral IP from the same scope (global or regional) will be
- // assigned.
+ // ephemeral IPv4 address from the same scope (global or regional) will
+ // be assigned. A regional forwarding rule supports IPv4 only. A global
+ // forwarding rule supports either IPv4 or IPv6.
//
// When the load balancing scheme is INTERNAL, this can only be an RFC
// 1918 IP address belonging to the network/subnetwork configured for
// the forwarding rule. A reserved address cannot be used. If the field
// is empty, the IP address will be automatically allocated from the
// internal IP range of the subnetwork or network configured for this
- // forwarding rule. Only IPv4 is supported.
+ // forwarding rule.
IPAddress string `json:"IPAddress,omitempty"`
// IPProtocol: The IP protocol to which this rule applies. Valid options
@@ -9374,8 +9383,8 @@
// receive packets with destination IP addresses other than their own.
// If these instances will be used as an IP gateway or it will be set as
// the next-hop in a Route resource, specify true. If unsure, leave this
- // set to false. See the Enable IP forwarding for instances
- // documentation for more information.
+ // set to false. See the Enable IP forwarding documentation for more
+ // information.
CanIpForward bool `json:"canIpForward,omitempty"`
// Description: An optional text description for the instances that are
@@ -9964,7 +9973,7 @@
}
// Interconnect: Protocol definitions for Mixer API to support
-// Interconnect. Next available tag: 20
+// Interconnect. Next available tag: 21
type Interconnect struct {
// AdminEnabled: Administrative status of the interconnect. When this is
// set to ?true?, the Interconnect is functional and may carry traffic
@@ -10517,6 +10526,27 @@
// each line in the address is separated by a newline character.
Address string `json:"address,omitempty"`
+ // AvailabilityZone: Availability zone for this location. Within a city,
+ // maintenance will not be simultaneously scheduled in more than one
+ // availability zone. Example: "zone1" or "zone2".
+ AvailabilityZone string `json:"availabilityZone,omitempty"`
+
+ // City: City designator used by the Interconnect UI to locate this
+ // InterconnectLocation within the Continent. For example: "Chicago,
+ // IL", "Amsterdam, Netherlands".
+ City string `json:"city,omitempty"`
+
+ // Continent: Continent for this location. Used by the location picker
+ // in the Interconnect UI.
+ //
+ // Possible values:
+ // "C_AFRICA"
+ // "C_ASIA_PAC"
+ // "C_EUROPE"
+ // "C_NORTH_AMERICA"
+ // "C_SOUTH_AMERICA"
+ Continent string `json:"continent,omitempty"`
+
// CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
// format.
CreationTimestamp string `json:"creationTimestamp,omitempty"`
@@ -10824,10 +10854,13 @@
// LogConfig: Specifies what kind of log the caller must write
type LogConfig struct {
+ // CloudAudit: Cloud audit options.
+ CloudAudit *LogConfigCloudAuditOptions `json:"cloudAudit,omitempty"`
+
// Counter: Counter options.
Counter *LogConfigCounterOptions `json:"counter,omitempty"`
- // ForceSendFields is a list of field names (e.g. "Counter") to
+ // 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
@@ -10835,7 +10868,7 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Counter") to include in
+ // 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
@@ -10850,6 +10883,39 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// LogConfigCloudAuditOptions: Write a Cloud Audit log
+type LogConfigCloudAuditOptions struct {
+ // LogName: The log_name to populate in the Cloud Audit Record.
+ //
+ // Possible values:
+ // "ADMIN_ACTIVITY"
+ // "DATA_ACCESS"
+ // "UNSPECIFIED_LOG_NAME"
+ LogName string `json:"logName,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "LogName") 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. "LogName") 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 *LogConfigCloudAuditOptions) MarshalJSON() ([]byte, error) {
+ type noMethod LogConfigCloudAuditOptions
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// LogConfigCounterOptions: Options for counters
type LogConfigCounterOptions struct {
// Field: The field value to attribute.
@@ -11260,6 +11326,9 @@
// create or delete the instance.
LastAttempt *ManagedInstanceLastAttempt `json:"lastAttempt,omitempty"`
+ // Override: [Output Only] Override defined for this instance.
+ Override *ManagedInstanceOverride `json:"override,omitempty"`
+
// StandbyMode: [Output Only] Standby mode of the instance. This field
// is non-empty iff the instance is a standby.
//
@@ -11388,6 +11457,77 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// ManagedInstanceOverride: Overrides of stateful properties for a given
+// instance
+type ManagedInstanceOverride struct {
+ // Disks: The disk overrides defined for this instance
+ Disks []*ManagedInstanceOverrideDiskOverride `json:"disks,omitempty"`
+
+ // Instance: The URL of the instance.
+ Instance string `json:"instance,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Disks") 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. "Disks") 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 *ManagedInstanceOverride) MarshalJSON() ([]byte, error) {
+ type noMethod ManagedInstanceOverride
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+type ManagedInstanceOverrideDiskOverride struct {
+ // DeviceName: The name of the device on the VM
+ DeviceName string `json:"deviceName,omitempty"`
+
+ // Mode: The mode in which to attach this disk, either READ_WRITE or
+ // READ_ONLY. If not specified, the default is to attach the disk in
+ // READ_WRITE mode.
+ //
+ // Possible values:
+ // "READ_ONLY"
+ // "READ_WRITE"
+ Mode string `json:"mode,omitempty"`
+
+ // Source: The disk that is/will be mounted
+ Source string `json:"source,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "DeviceName") 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. "DeviceName") 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 *ManagedInstanceOverrideDiskOverride) MarshalJSON() ([]byte, error) {
+ type noMethod ManagedInstanceOverrideDiskOverride
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type ManagedInstanceVersion struct {
// InstanceTemplate: [Output Only] The intended template of the
// instance. This field is empty when current_action is one of {
@@ -12871,6 +13011,7 @@
// Metric: [Output Only] Name of the quota metric.
//
// Possible values:
+ // "AMD_S9300_GPUS"
// "AUTOSCALERS"
// "BACKEND_BUCKETS"
// "BACKEND_SERVICES"
@@ -13718,10 +13859,13 @@
// Commitment is composed of one or more of these).
type ResourceCommitment struct {
// Amount: The amount of the resource purchased (in a type-dependent
- // unit, such as bytes).
+ // unit, such as bytes). For vCPUs, this can just be an integer. For
+ // memory, this must be provided in MB. Memory must be a multiple of 256
+ // MB, with up to 6.5GB of memory per every vCPU.
Amount int64 `json:"amount,omitempty,string"`
- // Type: Type of resource for which this commitment applies.
+ // Type: Type of resource for which this commitment applies. Possible
+ // values are VCPU and MEMORY
//
// Possible values:
// "LOCAL_SSD"
@@ -15066,7 +15210,8 @@
Preview bool `json:"preview,omitempty"`
// Priority: An integer indicating the priority of a rule in the list.
- // Rules are evaluated in the increasing order of priority.
+ // The priority must be a positive value between 0 and 2147483647. Rules
+ // are evaluated in the increasing order of priority.
Priority int64 `json:"priority,omitempty"`
// ForceSendFields is a list of field names (e.g. "Action") to
@@ -15556,11 +15701,13 @@
CreationTimestamp string `json:"creationTimestamp,omitempty"`
// Description: An optional description of this resource. Provide this
- // property when you create the resource.
+ // property when you create the resource. This field can be set only at
+ // resource creation time.
Description string `json:"description,omitempty"`
// GatewayAddress: [Output Only] The gateway address for default routes
- // to reach destination addresses outside this subnetwork.
+ // to reach destination addresses outside this subnetwork. This field
+ // can be set only at resource creation time.
GatewayAddress string `json:"gatewayAddress,omitempty"`
// Id: [Output Only] The unique identifier for the resource. This
@@ -15570,7 +15717,8 @@
// IpCidrRange: The range of internal addresses that are owned by this
// subnetwork. Provide this property when you create the subnetwork. For
// example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and
- // non-overlapping within a network. Only IPv4 is supported.
+ // non-overlapping within a network. Only IPv4 is supported. This field
+ // can be set only at resource creation time.
IpCidrRange string `json:"ipCidrRange,omitempty"`
// Kind: [Output Only] Type of the resource. Always compute#subnetwork
@@ -15588,14 +15736,18 @@
// Network: The URL of the network to which this subnetwork belongs,
// provided by the client when initially creating the subnetwork. Only
- // networks that are in the distributed mode can have subnetworks.
+ // networks that are in the distributed mode can have subnetworks. This
+ // field can be set only at resource creation time.
Network string `json:"network,omitempty"`
// PrivateIpGoogleAccess: Whether the VMs in this subnet can access
- // Google services without assigned external IP addresses.
+ // Google services without assigned external IP addresses. This field
+ // can be both set at resource creation time and updated using
+ // setPrivateIpGoogleAccess.
PrivateIpGoogleAccess bool `json:"privateIpGoogleAccess,omitempty"`
- // Region: URL of the region where the Subnetwork resides.
+ // Region: URL of the region where the Subnetwork resides. This field
+ // can be set only at resource creation time.
Region string `json:"region,omitempty"`
// SecondaryIpRanges: An array of configurations for secondary IP ranges
@@ -42421,6 +42573,11 @@
// been removed from the group. You must separately verify the status of
// the abandoning action with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *InstanceGroupManagersService) AbandonInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersabandoninstancesrequest *InstanceGroupManagersAbandonInstancesRequest) *InstanceGroupManagersAbandonInstancesCall {
@@ -42527,7 +42684,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.abandonInstances",
// "parameterOrder": [
@@ -43012,6 +43169,11 @@
// deleted. You must separately verify the status of the deleting action
// with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *InstanceGroupManagersService) DeleteInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersdeleteinstancesrequest *InstanceGroupManagersDeleteInstancesRequest) *InstanceGroupManagersDeleteInstancesCall {
@@ -43118,7 +43280,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.deleteInstances",
// "parameterOrder": [
@@ -43350,6 +43512,7 @@
// with the listmanagedinstances method.
//
// A managed instance group can have up to 1000 VM instances per group.
+// Please contact Cloud Support if you need an increase in this limit.
func (r *InstanceGroupManagersService) Insert(project string, zone string, instancegroupmanager *InstanceGroupManager) *InstanceGroupManagersInsertCall {
c := &InstanceGroupManagersInsertCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -43452,7 +43615,7 @@
}
return ret, nil
// {
- // "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group.",
+ // "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.insert",
// "parameterOrder": [
@@ -44168,6 +44331,11 @@
// separately verify the status of the recreating action with the
// listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *InstanceGroupManagersService) RecreateInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersrecreateinstancesrequest *InstanceGroupManagersRecreateInstancesRequest) *InstanceGroupManagersRecreateInstancesCall {
@@ -44274,7 +44442,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.recreateInstances",
// "parameterOrder": [
@@ -44342,6 +44510,10 @@
// if the group has not yet added or deleted any instances. You must
// separately verify the status of the creating or deleting actions with
// the listmanagedinstances method.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or deleted.
func (r *InstanceGroupManagersService) Resize(project string, zone string, instanceGroupManager string, size int64) *InstanceGroupManagersResizeCall {
c := &InstanceGroupManagersResizeCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -44441,7 +44613,7 @@
}
return ret, nil
// {
- // "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ // "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.resize",
// "parameterOrder": [
@@ -44519,6 +44691,10 @@
// yet added or deleted any instances. You must separately verify the
// status of the creating, creatingWithoutRetries, or deleting actions
// with the get or listmanagedinstances method.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or deleted.
func (r *InstanceGroupManagersService) ResizeAdvanced(project string, zone string, instanceGroupManager string, instancegroupmanagersresizeadvancedrequest *InstanceGroupManagersResizeAdvancedRequest) *InstanceGroupManagersResizeAdvancedCall {
c := &InstanceGroupManagersResizeAdvancedCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -44623,7 +44799,7 @@
}
return ret, nil
// {
- // "description": "Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.\n\nIf you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.",
+ // "description": "Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.\n\nIf you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.resizeAdvanced",
// "parameterOrder": [
@@ -46958,6 +47134,10 @@
// RemoveInstances: Removes one or more instances from the specified
// instance group, but does not delete those instances.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration before the VM instance is removed or deleted.
func (r *InstanceGroupsService) RemoveInstances(project string, zone string, instanceGroup string, instancegroupsremoveinstancesrequest *InstanceGroupsRemoveInstancesRequest) *InstanceGroupsRemoveInstancesCall {
c := &InstanceGroupsRemoveInstancesCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -47062,7 +47242,7 @@
}
return ret, nil
// {
- // "description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
+ // "description": "Removes one or more instances from the specified instance group, but does not delete those instances.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.instanceGroups.removeInstances",
// "parameterOrder": [
@@ -56740,6 +56920,154 @@
}
+// method id "compute.licenses.delete":
+
+type LicensesDeleteCall struct {
+ s *Service
+ project string
+ license string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes the specified license.
+func (r *LicensesService) Delete(project string, license string) *LicensesDeleteCall {
+ c := &LicensesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.license = license
+ return c
+}
+
+// RequestId sets the optional parameter "requestId": begin_interface:
+// MixerMutationRequestBuilder Request ID to support idempotency.
+func (c *LicensesDeleteCall) RequestId(requestId string) *LicensesDeleteCall {
+ c.urlParams_.Set("requestId", requestId)
+ 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 *LicensesDeleteCall) Fields(s ...googleapi.Field) *LicensesDeleteCall {
+ 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 *LicensesDeleteCall) Context(ctx context.Context) *LicensesDeleteCall {
+ 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 *LicensesDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *LicensesDeleteCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/licenses/{license}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ "license": c.license,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.licenses.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 *LicensesDeleteCall) 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 the specified license.",
+ // "httpMethod": "DELETE",
+ // "id": "compute.licenses.delete",
+ // "parameterOrder": [
+ // "project",
+ // "license"
+ // ],
+ // "parameters": {
+ // "license": {
+ // "description": "Name of the license resource to delete.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "requestId": {
+ // "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/global/licenses/{license}",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
// method id "compute.licenses.get":
type LicensesGetCall struct {
@@ -64391,7 +64719,7 @@
header_ http.Header
}
-// Insert: Creates an commitment in the specified project using the data
+// Insert: Creates a commitment in the specified project using the data
// included in the request.
func (r *RegionCommitmentsService) Insert(project string, region string, commitment *Commitment) *RegionCommitmentsInsertCall {
c := &RegionCommitmentsInsertCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -64401,8 +64729,17 @@
return c
}
-// RequestId sets the optional parameter "requestId": begin_interface:
-// MixerMutationRequestBuilder Request ID to support idempotency.
+// RequestId sets the optional parameter "requestId": An optional
+// request ID to identify requests. Specify a unique request ID so that
+// if you must retry your request, the server will know to ignore the
+// request if it has already been completed.
+//
+// For example, consider a situation where you make an initial request
+// and then the request times out. If you make the request again with
+// the same request ID, the server can check if original operation with
+// the same request ID was received, and if so, will ignore the second
+// request. This prevents clients from accidentally creating duplicate
+// commitments.
func (c *RegionCommitmentsInsertCall) RequestId(requestId string) *RegionCommitmentsInsertCall {
c.urlParams_.Set("requestId", requestId)
return c
@@ -64495,7 +64832,7 @@
}
return ret, nil
// {
- // "description": "Creates an commitment in the specified project using the data included in the request.",
+ // "description": "Creates a commitment in the specified project using the data included in the request.",
// "httpMethod": "POST",
// "id": "compute.regionCommitments.insert",
// "parameterOrder": [
@@ -64518,7 +64855,7 @@
// "type": "string"
// },
// "requestId": {
- // "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
+ // "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and then the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.",
// "location": "query",
// "type": "string"
// }
@@ -66845,6 +67182,11 @@
// been removed from the group. You must separately verify the status of
// the abandoning action with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *RegionInstanceGroupManagersService) AbandonInstances(project string, region string, instanceGroupManager string, regioninstancegroupmanagersabandoninstancesrequest *RegionInstanceGroupManagersAbandonInstancesRequest) *RegionInstanceGroupManagersAbandonInstancesCall {
@@ -66951,7 +67293,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.abandonInstances",
// "parameterOrder": [
@@ -67180,6 +67522,11 @@
// deleted. You must separately verify the status of the deleting action
// with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *RegionInstanceGroupManagersService) DeleteInstances(project string, region string, instanceGroupManager string, regioninstancegroupmanagersdeleteinstancesrequest *RegionInstanceGroupManagersDeleteInstancesRequest) *RegionInstanceGroupManagersDeleteInstancesCall {
@@ -67286,7 +67633,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.deleteInstances",
// "parameterOrder": [
@@ -68333,6 +68680,11 @@
// separately verify the status of the recreating action with the
// listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *RegionInstanceGroupManagersService) RecreateInstances(project string, region string, instanceGroupManager string, regioninstancegroupmanagersrecreaterequest *RegionInstanceGroupManagersRecreateRequest) *RegionInstanceGroupManagersRecreateInstancesCall {
@@ -68439,7 +68791,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.recreateInstances",
// "parameterOrder": [
@@ -68508,6 +68860,10 @@
// scheduled even if the group has not yet added or deleted any
// instances. You must separately verify the status of the creating or
// deleting actions with the listmanagedinstances method.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or deleted.
func (r *RegionInstanceGroupManagersService) Resize(project string, region string, instanceGroupManager string, size int64) *RegionInstanceGroupManagersResizeCall {
c := &RegionInstanceGroupManagersResizeCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -68607,7 +68963,7 @@
}
return ret, nil
// {
- // "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ // "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.resize",
// "parameterOrder": [
diff --git a/compute/v0.beta/compute-api.json b/compute/v0.beta/compute-api.json
index 88534e0..1a12497 100644
--- a/compute/v0.beta/compute-api.json
+++ b/compute/v0.beta/compute-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/JI1U0m9Assn9fDCGgvjuh-NNnzI\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/on50t1QJ0-zGVjeoBH8DCH0yiyk\"",
"discoveryVersion": "v1",
"id": "compute:beta",
"name": "compute",
"version": "beta",
- "revision": "20170423",
+ "revision": "20170530",
"title": "Compute Engine API",
"description": "Creates and runs virtual machines on Google Cloud Platform.",
"ownerDomain": "google.com",
@@ -1575,7 +1575,7 @@
"properties": {
"members": {
"type": "array",
- "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
+ "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
"items": {
"type": "string"
}
@@ -1635,7 +1635,7 @@
"Commitment": {
"id": "Commitment",
"type": "object",
- "description": "A usage-commitment with a start / end time. Users create commitments for particular resources (e.g. memory). Actual usage is first deducted from available commitments made prior, perhaps at a reduced price (as laid out in the commitment).",
+ "description": "Represents a Commitment resource. Creating a Commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.\n\nCommitted use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts.",
"properties": {
"creationTimestamp": {
"type": "string",
@@ -1699,7 +1699,7 @@
},
"status": {
"type": "string",
- "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end-date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.",
+ "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.",
"enum": [
"ACTIVE",
"CREATING",
@@ -2702,7 +2702,7 @@
"properties": {
"IPAddress": {
"type": "string",
- "description": "The IP address that this forwarding rule is serving on behalf of.\n\nFor global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.\n\nWhen the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. Only IPv4 is supported."
+ "description": "The IP address that this forwarding rule is serving on behalf of.\n\nFor global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6.\n\nWhen the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule."
},
"IPProtocol": {
"type": "string",
@@ -3710,6 +3710,10 @@
"$ref": "Metadata",
"description": "The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys."
},
+ "minCpuPlatform": {
+ "type": "string",
+ "description": "Minimum cpu/platform to be used by this instance. We may schedule on the specified or later cpu/platform."
+ },
"name": {
"type": "string",
"description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
@@ -3742,6 +3746,10 @@
"$ref": "ServiceAccount"
}
},
+ "startRestricted": {
+ "type": "boolean",
+ "description": "[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity."
+ },
"status": {
"type": "string",
"description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.",
@@ -4638,7 +4646,7 @@
"properties": {
"canIpForward": {
"type": "boolean",
- "description": "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information."
+ "description": "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information."
},
"description": {
"type": "string",
@@ -4678,6 +4686,10 @@
"$ref": "Metadata",
"description": "The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information."
},
+ "minCpuPlatform": {
+ "type": "string",
+ "description": "Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or later cpu/platform."
+ },
"networkInterfaces": {
"type": "array",
"description": "An array of network access configurations for this interface.",
@@ -4949,6 +4961,16 @@
}
}
},
+ "InstancesSetMinCpuPlatformRequest": {
+ "id": "InstancesSetMinCpuPlatformRequest",
+ "type": "object",
+ "properties": {
+ "minCpuPlatform": {
+ "type": "string",
+ "description": "Minimum cpu/platform this instance should be started at."
+ }
+ }
+ },
"InstancesSetServiceAccountRequest": {
"id": "InstancesSetServiceAccountRequest",
"type": "object",
@@ -5014,12 +5036,37 @@
"type": "object",
"description": "Specifies what kind of log the caller must write",
"properties": {
+ "cloudAudit": {
+ "$ref": "LogConfigCloudAuditOptions",
+ "description": "Cloud audit options."
+ },
"counter": {
"$ref": "LogConfigCounterOptions",
"description": "Counter options."
}
}
},
+ "LogConfigCloudAuditOptions": {
+ "id": "LogConfigCloudAuditOptions",
+ "type": "object",
+ "description": "Write a Cloud Audit log",
+ "properties": {
+ "logName": {
+ "type": "string",
+ "description": "The log_name to populate in the Cloud Audit Record.",
+ "enum": [
+ "ADMIN_ACTIVITY",
+ "DATA_ACCESS",
+ "UNSPECIFIED_LOG_NAME"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ },
"LogConfigCounterOptions": {
"id": "LogConfigCounterOptions",
"type": "object",
@@ -6671,12 +6718,12 @@
"properties": {
"amount": {
"type": "string",
- "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes).",
+ "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.",
"format": "int64"
},
"type": {
"type": "string",
- "description": "Type of resource for which this commitment applies.",
+ "description": "Type of resource for which this commitment applies. Possible values are VCPU and MEMORY",
"enum": [
"MEMORY",
"UNSPECIFIED",
@@ -7698,11 +7745,11 @@
},
"description": {
"type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
+ "description": "An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time."
},
"gatewayAddress": {
"type": "string",
- "description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork."
+ "description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time."
},
"id": {
"type": "string",
@@ -7711,7 +7758,7 @@
},
"ipCidrRange": {
"type": "string",
- "description": "The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported."
+ "description": "The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time."
},
"kind": {
"type": "string",
@@ -7725,15 +7772,15 @@
},
"network": {
"type": "string",
- "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks."
+ "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time."
},
"privateIpGoogleAccess": {
"type": "boolean",
- "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses."
+ "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess."
},
"region": {
"type": "string",
- "description": "URL of the region where the Subnetwork resides."
+ "description": "URL of the region where the Subnetwork resides. This field can be set only at resource creation time."
},
"secondaryIpRanges": {
"type": "array",
@@ -9678,6 +9725,13 @@
"type": "object",
"description": "A Zone resource.",
"properties": {
+ "availableCpuPlatforms": {
+ "type": "array",
+ "description": "[Output Only] Available cpu/platform selections for the zone.",
+ "items": {
+ "type": "string"
+ }
+ },
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
@@ -13914,7 +13968,7 @@
"id": "compute.instanceGroupManagers.abandonInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -14044,7 +14098,7 @@
"id": "compute.instanceGroupManagers.deleteInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -14126,7 +14180,7 @@
"id": "compute.instanceGroupManagers.insert",
"path": "{project}/zones/{zone}/instanceGroupManagers",
"httpMethod": "POST",
- "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group.",
+ "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.",
"parameters": {
"project": {
"type": "string",
@@ -14319,7 +14373,7 @@
"id": "compute.instanceGroupManagers.recreateInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -14361,7 +14415,7 @@
"id": "compute.instanceGroupManagers.resize",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
"httpMethod": "POST",
- "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -14408,7 +14462,7 @@
"id": "compute.instanceGroupManagers.resizeAdvanced",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced",
"httpMethod": "POST",
- "description": "Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.\n\nIf you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.",
+ "description": "Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.\n\nIf you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -14994,7 +15048,7 @@
"id": "compute.instanceGroups.removeInstances",
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
"httpMethod": "POST",
- "description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
+ "description": "Removes one or more instances from the specified instance group, but does not delete those instances.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.",
"parameters": {
"instanceGroup": {
"type": "string",
@@ -16126,6 +16180,55 @@
"https://www.googleapis.com/auth/compute"
]
},
+ "setMinCpuPlatform": {
+ "id": "compute.instances.setMinCpuPlatform",
+ "path": "{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
+ "httpMethod": "POST",
+ "description": "Changes the minimum cpu/platform that this instance should be started as. This is called on a stopped instance.",
+ "parameters": {
+ "instance": {
+ "type": "string",
+ "description": "Name of the instance scoping this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
+ "location": "query"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "request": {
+ "$ref": "InstancesSetMinCpuPlatformRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
"setScheduling": {
"id": "compute.instances.setScheduling",
"path": "{project}/zones/{zone}/instances/{instance}/setScheduling",
@@ -18046,7 +18149,7 @@
"id": "compute.regionCommitments.insert",
"path": "{project}/regions/{region}/commitments",
"httpMethod": "POST",
- "description": "Creates an commitment in the specified project using the data included in the request.",
+ "description": "Creates a commitment in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
@@ -18143,7 +18246,7 @@
"id": "compute.regionInstanceGroupManagers.abandonInstances",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -18224,7 +18327,7 @@
"id": "compute.regionInstanceGroupManagers.deleteInstances",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -18499,7 +18602,7 @@
"id": "compute.regionInstanceGroupManagers.recreateInstances",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -18541,7 +18644,7 @@
"id": "compute.regionInstanceGroupManagers.resize",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize",
"httpMethod": "POST",
- "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
"parameters": {
"instanceGroupManager": {
"type": "string",
diff --git a/compute/v0.beta/compute-gen.go b/compute/v0.beta/compute-gen.go
index fa7a530..b7ec0e1 100644
--- a/compute/v0.beta/compute-gen.go
+++ b/compute/v0.beta/compute-gen.go
@@ -3075,6 +3075,8 @@
// * `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"`
@@ -3189,10 +3191,16 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Commitment: A usage-commitment with a start / end time. Users create
-// commitments for particular resources (e.g. memory). Actual usage is
-// first deducted from available commitments made prior, perhaps at a
-// reduced price (as laid out in the commitment).
+// Commitment: Represents a Commitment resource. Creating a Commitment
+// resource means that you are purchasing a committed use contract with
+// an explicit start and end time. You can create commitments based on
+// vCPUs and memory usage and receive discounted rates. For full
+// details, read Signing Up for Committed Use Discounts.
+//
+// Committed use discounts are subject to Google Cloud Platform's
+// Service Specific Terms. By purchasing a committed use discount, you
+// agree to these terms. Committed use discounts will not renew, so you
+// must purchase a new commitment to continue receiving discounts.
type Commitment struct {
// CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
// format.
@@ -3249,7 +3257,7 @@
StartTimestamp string `json:"startTimestamp,omitempty"`
// Status: [Output Only] Status of the commitment with regards to
- // eventual expiration (each commitment has an end-date defined). One of
+ // eventual expiration (each commitment has an end date defined). One of
// the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
//
// Possible values:
@@ -4827,15 +4835,16 @@
// For global forwarding rules, the address must be a global IP. For
// regional forwarding rules, the address must live in the same region
// as the forwarding rule. By default, this field is empty and an
- // ephemeral IP from the same scope (global or regional) will be
- // assigned.
+ // ephemeral IPv4 address from the same scope (global or regional) will
+ // be assigned. A regional forwarding rule supports IPv4 only. A global
+ // forwarding rule supports either IPv4 or IPv6.
//
// When the load balancing scheme is INTERNAL, this can only be an RFC
// 1918 IP address belonging to the network/subnetwork configured for
// the forwarding rule. A reserved address cannot be used. If the field
// is empty, the IP address will be automatically allocated from the
// internal IP range of the subnetwork or network configured for this
- // forwarding rule. Only IPv4 is supported.
+ // forwarding rule.
IPAddress string `json:"IPAddress,omitempty"`
// IPProtocol: The IP protocol to which this rule applies. Valid options
@@ -6306,6 +6315,10 @@
// This includes custom metadata and predefined keys.
Metadata *Metadata `json:"metadata,omitempty"`
+ // MinCpuPlatform: Minimum cpu/platform to be used by this instance. We
+ // may schedule on the specified or later cpu/platform.
+ MinCpuPlatform string `json:"minCpuPlatform,omitempty"`
+
// Name: The name of the resource, provided by the client when initially
// creating the resource. The resource name must be 1-63 characters
// long, and comply with RFC1035. Specifically, the name must be 1-63
@@ -6337,6 +6350,10 @@
// instance. See Service Accounts for more information.
ServiceAccounts []*ServiceAccount `json:"serviceAccounts,omitempty"`
+ // StartRestricted: [Output Only] Whether a VM has been restricted for
+ // start because Compute Engine has detected suspicious activity.
+ StartRestricted bool `json:"startRestricted,omitempty"`
+
// Status: [Output Only] The status of the instance. One of the
// following values: PROVISIONING, STAGING, RUNNING, STOPPING,
// SUSPENDING, SUSPENDED, and TERMINATED.
@@ -7837,8 +7854,8 @@
// receive packets with destination IP addresses other than their own.
// If these instances will be used as an IP gateway or it will be set as
// the next-hop in a Route resource, specify true. If unsure, leave this
- // set to false. See the Enable IP forwarding for instances
- // documentation for more information.
+ // set to false. See the Enable IP forwarding documentation for more
+ // information.
CanIpForward bool `json:"canIpForward,omitempty"`
// Description: An optional text description for the instances that are
@@ -7867,6 +7884,10 @@
// more information.
Metadata *Metadata `json:"metadata,omitempty"`
+ // MinCpuPlatform: Minimum cpu/platform to be used by this instance. The
+ // instance may be scheduled on the specified or later cpu/platform.
+ MinCpuPlatform string `json:"minCpuPlatform,omitempty"`
+
// NetworkInterfaces: An array of network access configurations for this
// interface.
NetworkInterfaces []*NetworkInterface `json:"networkInterfaces,omitempty"`
@@ -8312,6 +8333,35 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type InstancesSetMinCpuPlatformRequest struct {
+ // MinCpuPlatform: Minimum cpu/platform this instance should be started
+ // at.
+ MinCpuPlatform string `json:"minCpuPlatform,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "MinCpuPlatform") 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. "MinCpuPlatform") 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 *InstancesSetMinCpuPlatformRequest) MarshalJSON() ([]byte, error) {
+ type noMethod InstancesSetMinCpuPlatformRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type InstancesSetServiceAccountRequest struct {
// Email: Email address of the service account.
Email string `json:"email,omitempty"`
@@ -8424,10 +8474,13 @@
// LogConfig: Specifies what kind of log the caller must write
type LogConfig struct {
+ // CloudAudit: Cloud audit options.
+ CloudAudit *LogConfigCloudAuditOptions `json:"cloudAudit,omitempty"`
+
// Counter: Counter options.
Counter *LogConfigCounterOptions `json:"counter,omitempty"`
- // ForceSendFields is a list of field names (e.g. "Counter") to
+ // 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
@@ -8435,7 +8488,7 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Counter") to include in
+ // 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
@@ -8450,6 +8503,39 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// LogConfigCloudAuditOptions: Write a Cloud Audit log
+type LogConfigCloudAuditOptions struct {
+ // LogName: The log_name to populate in the Cloud Audit Record.
+ //
+ // Possible values:
+ // "ADMIN_ACTIVITY"
+ // "DATA_ACCESS"
+ // "UNSPECIFIED_LOG_NAME"
+ LogName string `json:"logName,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "LogName") 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. "LogName") 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 *LogConfigCloudAuditOptions) MarshalJSON() ([]byte, error) {
+ type noMethod LogConfigCloudAuditOptions
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// LogConfigCounterOptions: Options for counters
type LogConfigCounterOptions struct {
// Field: The field value to attribute.
@@ -11094,10 +11180,13 @@
// Commitment is composed of one or more of these).
type ResourceCommitment struct {
// Amount: The amount of the resource purchased (in a type-dependent
- // unit, such as bytes).
+ // unit, such as bytes). For vCPUs, this can just be an integer. For
+ // memory, this must be provided in MB. Memory must be a multiple of 256
+ // MB, with up to 6.5GB of memory per every vCPU.
Amount int64 `json:"amount,omitempty,string"`
- // Type: Type of resource for which this commitment applies.
+ // Type: Type of resource for which this commitment applies. Possible
+ // values are VCPU and MEMORY
//
// Possible values:
// "MEMORY"
@@ -12573,11 +12662,13 @@
CreationTimestamp string `json:"creationTimestamp,omitempty"`
// Description: An optional description of this resource. Provide this
- // property when you create the resource.
+ // property when you create the resource. This field can be set only at
+ // resource creation time.
Description string `json:"description,omitempty"`
// GatewayAddress: [Output Only] The gateway address for default routes
- // to reach destination addresses outside this subnetwork.
+ // to reach destination addresses outside this subnetwork. This field
+ // can be set only at resource creation time.
GatewayAddress string `json:"gatewayAddress,omitempty"`
// Id: [Output Only] The unique identifier for the resource. This
@@ -12587,7 +12678,8 @@
// IpCidrRange: The range of internal addresses that are owned by this
// subnetwork. Provide this property when you create the subnetwork. For
// example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and
- // non-overlapping within a network. Only IPv4 is supported.
+ // non-overlapping within a network. Only IPv4 is supported. This field
+ // can be set only at resource creation time.
IpCidrRange string `json:"ipCidrRange,omitempty"`
// Kind: [Output Only] Type of the resource. Always compute#subnetwork
@@ -12605,14 +12697,18 @@
// Network: The URL of the network to which this subnetwork belongs,
// provided by the client when initially creating the subnetwork. Only
- // networks that are in the distributed mode can have subnetworks.
+ // networks that are in the distributed mode can have subnetworks. This
+ // field can be set only at resource creation time.
Network string `json:"network,omitempty"`
// PrivateIpGoogleAccess: Whether the VMs in this subnet can access
- // Google services without assigned external IP addresses.
+ // Google services without assigned external IP addresses. This field
+ // can be both set at resource creation time and updated using
+ // setPrivateIpGoogleAccess.
PrivateIpGoogleAccess bool `json:"privateIpGoogleAccess,omitempty"`
- // Region: URL of the region where the Subnetwork resides.
+ // Region: URL of the region where the Subnetwork resides. This field
+ // can be set only at resource creation time.
Region string `json:"region,omitempty"`
// SecondaryIpRanges: An array of configurations for secondary IP ranges
@@ -15806,6 +15902,10 @@
// Zone: A Zone resource.
type Zone struct {
+ // AvailableCpuPlatforms: [Output Only] Available cpu/platform
+ // selections for the zone.
+ AvailableCpuPlatforms []string `json:"availableCpuPlatforms,omitempty"`
+
// CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
// format.
CreationTimestamp string `json:"creationTimestamp,omitempty"`
@@ -15846,15 +15946,16 @@
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
- // 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 is a list of field names (e.g.
+ // "AvailableCpuPlatforms") 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. "CreationTimestamp") to
+ // NullFields is a list of field names (e.g. "AvailableCpuPlatforms") 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
@@ -33723,6 +33824,11 @@
// been removed from the group. You must separately verify the status of
// the abandoning action with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *InstanceGroupManagersService) AbandonInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersabandoninstancesrequest *InstanceGroupManagersAbandonInstancesRequest) *InstanceGroupManagersAbandonInstancesCall {
@@ -33822,7 +33928,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.abandonInstances",
// "parameterOrder": [
@@ -34290,6 +34396,11 @@
// deleted. You must separately verify the status of the deleting action
// with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *InstanceGroupManagersService) DeleteInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersdeleteinstancesrequest *InstanceGroupManagersDeleteInstancesRequest) *InstanceGroupManagersDeleteInstancesCall {
@@ -34389,7 +34500,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.deleteInstances",
// "parameterOrder": [
@@ -34616,6 +34727,7 @@
// with the listmanagedinstances method.
//
// A managed instance group can have up to 1000 VM instances per group.
+// Please contact Cloud Support if you need an increase in this limit.
func (r *InstanceGroupManagersService) Insert(project string, zone string, instancegroupmanager *InstanceGroupManager) *InstanceGroupManagersInsertCall {
c := &InstanceGroupManagersInsertCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -34711,7 +34823,7 @@
}
return ret, nil
// {
- // "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group.",
+ // "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.insert",
// "parameterOrder": [
@@ -35410,6 +35522,11 @@
// separately verify the status of the recreating action with the
// listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *InstanceGroupManagersService) RecreateInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersrecreateinstancesrequest *InstanceGroupManagersRecreateInstancesRequest) *InstanceGroupManagersRecreateInstancesCall {
@@ -35509,7 +35626,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.recreateInstances",
// "parameterOrder": [
@@ -35572,6 +35689,10 @@
// if the group has not yet added or deleted any instances. You must
// separately verify the status of the creating or deleting actions with
// the listmanagedinstances method.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or deleted.
func (r *InstanceGroupManagersService) Resize(project string, zone string, instanceGroupManager string, size int64) *InstanceGroupManagersResizeCall {
c := &InstanceGroupManagersResizeCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -35664,7 +35785,7 @@
}
return ret, nil
// {
- // "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ // "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.resize",
// "parameterOrder": [
@@ -35737,6 +35858,10 @@
// yet added or deleted any instances. You must separately verify the
// status of the creating, creatingWithoutRetries, or deleting actions
// with the get or listmanagedinstances method.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or deleted.
func (r *InstanceGroupManagersService) ResizeAdvanced(project string, zone string, instanceGroupManager string, instancegroupmanagersresizeadvancedrequest *InstanceGroupManagersResizeAdvancedRequest) *InstanceGroupManagersResizeAdvancedCall {
c := &InstanceGroupManagersResizeAdvancedCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -35834,7 +35959,7 @@
}
return ret, nil
// {
- // "description": "Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.\n\nIf you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.",
+ // "description": "Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.\n\nIf you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.resizeAdvanced",
// "parameterOrder": [
@@ -38080,6 +38205,10 @@
// RemoveInstances: Removes one or more instances from the specified
// instance group, but does not delete those instances.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration before the VM instance is removed or deleted.
func (r *InstanceGroupsService) RemoveInstances(project string, zone string, instanceGroup string, instancegroupsremoveinstancesrequest *InstanceGroupsRemoveInstancesRequest) *InstanceGroupsRemoveInstancesCall {
c := &InstanceGroupsRemoveInstancesCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -38177,7 +38306,7 @@
}
return ret, nil
// {
- // "description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
+ // "description": "Removes one or more instances from the specified instance group, but does not delete those instances.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.instanceGroups.removeInstances",
// "parameterOrder": [
@@ -42419,6 +42548,176 @@
}
+// method id "compute.instances.setMinCpuPlatform":
+
+type InstancesSetMinCpuPlatformCall struct {
+ s *Service
+ project string
+ zone string
+ instance string
+ instancessetmincpuplatformrequest *InstancesSetMinCpuPlatformRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetMinCpuPlatform: Changes the minimum cpu/platform that this
+// instance should be started as. This is called on a stopped instance.
+func (r *InstancesService) SetMinCpuPlatform(project string, zone string, instance string, instancessetmincpuplatformrequest *InstancesSetMinCpuPlatformRequest) *InstancesSetMinCpuPlatformCall {
+ c := &InstancesSetMinCpuPlatformCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.zone = zone
+ c.instance = instance
+ c.instancessetmincpuplatformrequest = instancessetmincpuplatformrequest
+ return c
+}
+
+// RequestId sets the optional parameter "requestId": begin_interface:
+// MixerMutationRequestBuilder Request ID to support idempotency.
+func (c *InstancesSetMinCpuPlatformCall) RequestId(requestId string) *InstancesSetMinCpuPlatformCall {
+ c.urlParams_.Set("requestId", requestId)
+ 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 *InstancesSetMinCpuPlatformCall) Fields(s ...googleapi.Field) *InstancesSetMinCpuPlatformCall {
+ 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 *InstancesSetMinCpuPlatformCall) Context(ctx context.Context) *InstancesSetMinCpuPlatformCall {
+ 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 *InstancesSetMinCpuPlatformCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *InstancesSetMinCpuPlatformCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancessetmincpuplatformrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ "zone": c.zone,
+ "instance": c.instance,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.instances.setMinCpuPlatform" 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 *InstancesSetMinCpuPlatformCall) 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": "Changes the minimum cpu/platform that this instance should be started as. This is called on a stopped instance.",
+ // "httpMethod": "POST",
+ // "id": "compute.instances.setMinCpuPlatform",
+ // "parameterOrder": [
+ // "project",
+ // "zone",
+ // "instance"
+ // ],
+ // "parameters": {
+ // "instance": {
+ // "description": "Name of the instance scoping this request.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "requestId": {
+ // "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the zone for this request.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
+ // "request": {
+ // "$ref": "InstancesSetMinCpuPlatformRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
// method id "compute.instances.setScheduling":
type InstancesSetSchedulingCall struct {
@@ -50360,7 +50659,7 @@
header_ http.Header
}
-// Insert: Creates an commitment in the specified project using the data
+// Insert: Creates a commitment in the specified project using the data
// included in the request.
func (r *RegionCommitmentsService) Insert(project string, region string, commitment *Commitment) *RegionCommitmentsInsertCall {
c := &RegionCommitmentsInsertCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -50457,7 +50756,7 @@
}
return ret, nil
// {
- // "description": "Creates an commitment in the specified project using the data included in the request.",
+ // "description": "Creates a commitment in the specified project using the data included in the request.",
// "httpMethod": "POST",
// "id": "compute.regionCommitments.insert",
// "parameterOrder": [
@@ -50782,6 +51081,11 @@
// been removed from the group. You must separately verify the status of
// the abandoning action with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *RegionInstanceGroupManagersService) AbandonInstances(project string, region string, instanceGroupManager string, regioninstancegroupmanagersabandoninstancesrequest *RegionInstanceGroupManagersAbandonInstancesRequest) *RegionInstanceGroupManagersAbandonInstancesCall {
@@ -50881,7 +51185,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.abandonInstances",
// "parameterOrder": [
@@ -51093,6 +51397,11 @@
// deleted. You must separately verify the status of the deleting action
// with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *RegionInstanceGroupManagersService) DeleteInstances(project string, region string, instanceGroupManager string, regioninstancegroupmanagersdeleteinstancesrequest *RegionInstanceGroupManagersDeleteInstancesRequest) *RegionInstanceGroupManagersDeleteInstancesCall {
@@ -51192,7 +51501,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.deleteInstances",
// "parameterOrder": [
@@ -52210,6 +52519,11 @@
// separately verify the status of the recreating action with the
// listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *RegionInstanceGroupManagersService) RecreateInstances(project string, region string, instanceGroupManager string, regioninstancegroupmanagersrecreaterequest *RegionInstanceGroupManagersRecreateRequest) *RegionInstanceGroupManagersRecreateInstancesCall {
@@ -52309,7 +52623,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.recreateInstances",
// "parameterOrder": [
@@ -52373,6 +52687,10 @@
// scheduled even if the group has not yet added or deleted any
// instances. You must separately verify the status of the creating or
// deleting actions with the listmanagedinstances method.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or deleted.
func (r *RegionInstanceGroupManagersService) Resize(project string, region string, instanceGroupManager string, size int64) *RegionInstanceGroupManagersResizeCall {
c := &RegionInstanceGroupManagersResizeCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -52465,7 +52783,7 @@
}
return ret, nil
// {
- // "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ // "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.resize",
// "parameterOrder": [
diff --git a/compute/v1/compute-api.json b/compute/v1/compute-api.json
index 2288754..9edd7bc 100644
--- a/compute/v1/compute-api.json
+++ b/compute/v1/compute-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/3btFW0E1ousFJmi4fe3MPtPMoc8\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/UbDB7_K3R-uvPek__mbq9Pi-1gA\"",
"discoveryVersion": "v1",
"id": "compute:v1",
"name": "compute",
"version": "v1",
- "revision": "20170423",
+ "revision": "20170530",
"title": "Compute Engine API",
"description": "Creates and runs virtual machines on Google Cloud Platform.",
"ownerDomain": "google.com",
@@ -1349,6 +1349,18 @@
"description": "[Output Only] Type of the resource. Always compute#disk for disks.",
"default": "compute#disk"
},
+ "labelFingerprint": {
+ "type": "string",
+ "description": "A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make a get() request to retrieve a disk.",
+ "format": "byte"
+ },
+ "labels": {
+ "type": "object",
+ "description": "Labels to apply to this disk. These can be later modified by the setLabels method.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"lastAttachTimestamp": {
"type": "string",
"description": "[Output Only] Last attach timestamp in RFC3339 text format."
@@ -1931,7 +1943,7 @@
"properties": {
"IPAddress": {
"type": "string",
- "description": "The IP address that this forwarding rule is serving on behalf of.\n\nFor global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.\n\nWhen the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. Only IPv4 is supported."
+ "description": "The IP address that this forwarding rule is serving on behalf of.\n\nFor global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6.\n\nWhen the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule."
},
"IPProtocol": {
"type": "string",
@@ -2171,6 +2183,24 @@
}
}
},
+ "GlobalSetLabelsRequest": {
+ "id": "GlobalSetLabelsRequest",
+ "type": "object",
+ "properties": {
+ "labelFingerprint": {
+ "type": "string",
+ "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.",
+ "format": "byte"
+ },
+ "labels": {
+ "type": "object",
+ "description": "A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\").",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
"GuestOsFeature": {
"id": "GuestOsFeature",
"type": "object",
@@ -2688,6 +2718,18 @@
"description": "[Output Only] Type of the resource. Always compute#image for images.",
"default": "compute#image"
},
+ "labelFingerprint": {
+ "type": "string",
+ "description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make a get() request to retrieve an image.",
+ "format": "byte"
+ },
+ "labels": {
+ "type": "object",
+ "description": "Labels to apply to this image. These can be later modified by the setLabels method.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"licenses": {
"type": "array",
"description": "Any applicable license URI.",
@@ -2847,6 +2889,18 @@
"description": "[Output Only] Type of the resource. Always compute#instance for instances.",
"default": "compute#instance"
},
+ "labelFingerprint": {
+ "type": "string",
+ "description": "A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.\n\nTo see the latest fingerprint, make get() request to the instance.",
+ "format": "byte"
+ },
+ "labels": {
+ "type": "object",
+ "description": "Labels to apply to this instance. These can be later modified by the setLabels method.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"machineType": {
"type": "string",
"description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:\n\nzones/us-central1-f/machineTypes/n1-standard-1 \n\nTo create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):\n\nzones/zone/machineTypes/custom-CPUS-MEMORY \n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120 \n\nFor a full list of restrictions, read the Specifications for custom machine types.",
@@ -2892,6 +2946,10 @@
"$ref": "ServiceAccount"
}
},
+ "startRestricted": {
+ "type": "boolean",
+ "description": "[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity."
+ },
"status": {
"type": "string",
"description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.",
@@ -3688,7 +3746,7 @@
"properties": {
"canIpForward": {
"type": "boolean",
- "description": "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information."
+ "description": "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information."
},
"description": {
"type": "string",
@@ -3701,6 +3759,13 @@
"$ref": "AttachedDisk"
}
},
+ "labels": {
+ "type": "object",
+ "description": "Labels to apply to instances that are created from this template.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"machineType": {
"type": "string",
"description": "The machine type to use for instances that are created from this template.",
@@ -3945,6 +4010,23 @@
}
}
},
+ "InstancesSetLabelsRequest": {
+ "id": "InstancesSetLabelsRequest",
+ "type": "object",
+ "properties": {
+ "labelFingerprint": {
+ "type": "string",
+ "description": "Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.",
+ "format": "byte"
+ },
+ "labels": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
"InstancesSetMachineTypeRequest": {
"id": "InstancesSetMachineTypeRequest",
"type": "object",
@@ -4982,6 +5064,70 @@
"usageExportLocation": {
"$ref": "UsageExportLocation",
"description": "The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored."
+ },
+ "xpnProjectStatus": {
+ "type": "string",
+ "description": "[Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.",
+ "enum": [
+ "HOST",
+ "UNSPECIFIED_XPN_PROJECT_STATUS"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ }
+ }
+ },
+ "ProjectsDisableXpnResourceRequest": {
+ "id": "ProjectsDisableXpnResourceRequest",
+ "type": "object",
+ "properties": {
+ "xpnResource": {
+ "$ref": "XpnResourceId",
+ "description": "XPN resource ID."
+ }
+ }
+ },
+ "ProjectsEnableXpnResourceRequest": {
+ "id": "ProjectsEnableXpnResourceRequest",
+ "type": "object",
+ "properties": {
+ "xpnResource": {
+ "$ref": "XpnResourceId",
+ "description": "XPN resource ID."
+ }
+ }
+ },
+ "ProjectsGetXpnResources": {
+ "id": "ProjectsGetXpnResources",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of XPN resources.",
+ "default": "compute#projectsGetXpnResources"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "resources": {
+ "type": "array",
+ "description": "XPN resources attached to this project as their XPN host.",
+ "items": {
+ "$ref": "XpnResourceId"
+ }
+ }
+ }
+ },
+ "ProjectsListXpnHostsRequest": {
+ "id": "ProjectsListXpnHostsRequest",
+ "type": "object",
+ "properties": {
+ "organization": {
+ "type": "string",
+ "description": "Optional organization ID managed by Cloud Resource Manager, for which to list XPN host projects. If not specified, the organization will be inferred from the project."
}
}
},
@@ -6160,6 +6306,18 @@
"description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.",
"default": "compute#snapshot"
},
+ "labelFingerprint": {
+ "type": "string",
+ "description": "A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make a get() request to retrieve a snapshot.",
+ "format": "byte"
+ },
+ "labels": {
+ "type": "object",
+ "description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"licenses": {
"type": "array",
"description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).",
@@ -6344,11 +6502,11 @@
},
"description": {
"type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
+ "description": "An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time."
},
"gatewayAddress": {
"type": "string",
- "description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork."
+ "description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time."
},
"id": {
"type": "string",
@@ -6357,7 +6515,7 @@
},
"ipCidrRange": {
"type": "string",
- "description": "The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported."
+ "description": "The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time."
},
"kind": {
"type": "string",
@@ -6371,15 +6529,15 @@
},
"network": {
"type": "string",
- "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks."
+ "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time."
},
"privateIpGoogleAccess": {
"type": "boolean",
- "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses."
+ "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess."
},
"region": {
"type": "string",
- "description": "URL of the region where the Subnetwork resides."
+ "description": "URL of the region where the Subnetwork resides. This field can be set only at resource creation time."
},
"selfLink": {
"type": "string",
@@ -7388,6 +7546,115 @@
}
}
},
+ "TargetTcpProxiesSetBackendServiceRequest": {
+ "id": "TargetTcpProxiesSetBackendServiceRequest",
+ "type": "object",
+ "properties": {
+ "service": {
+ "type": "string",
+ "description": "The URL of the new BackendService resource for the targetTcpProxy."
+ }
+ }
+ },
+ "TargetTcpProxiesSetProxyHeaderRequest": {
+ "id": "TargetTcpProxiesSetProxyHeaderRequest",
+ "type": "object",
+ "properties": {
+ "proxyHeader": {
+ "type": "string",
+ "description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.",
+ "enum": [
+ "NONE",
+ "PROXY_V1"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ }
+ }
+ },
+ "TargetTcpProxy": {
+ "id": "TargetTcpProxy",
+ "type": "object",
+ "description": "A TargetTcpProxy resource. This resource defines a TCP proxy.",
+ "properties": {
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.",
+ "default": "compute#targetTcpProxy"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "proxyHeader": {
+ "type": "string",
+ "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
+ "enum": [
+ "NONE",
+ "PROXY_V1"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "service": {
+ "type": "string",
+ "description": "URL to the BackendService resource."
+ }
+ }
+ },
+ "TargetTcpProxyList": {
+ "id": "TargetTcpProxyList",
+ "type": "object",
+ "description": "Contains a list of TargetTcpProxy resources.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "items": {
+ "type": "array",
+ "description": "A list of TargetTcpProxy resources.",
+ "items": {
+ "$ref": "TargetTcpProxy"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "Type of resource.",
+ "default": "compute#targetTcpProxyList"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ }
+ },
"TargetVpnGateway": {
"id": "TargetVpnGateway",
"type": "object",
@@ -8086,6 +8353,59 @@
}
}
},
+ "XpnHostList": {
+ "id": "XpnHostList",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "items": {
+ "type": "array",
+ "description": "[Output Only] A list of XPN host project URLs.",
+ "items": {
+ "$ref": "Project"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#xpnHostList for lists of XPN hosts.",
+ "default": "compute#xpnHostList"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ }
+ },
+ "XpnResourceId": {
+ "id": "XpnResourceId",
+ "type": "object",
+ "description": "XpnResourceId",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the XPN resource.",
+ "enum": [
+ "PROJECT",
+ "XPN_RESOURCE_TYPE_UNSPECIFIED"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ }
+ }
+ },
"Zone": {
"id": "Zone",
"type": "object",
@@ -8169,6 +8489,24 @@
"description": "[Output Only] Server-defined URL for this resource."
}
}
+ },
+ "ZoneSetLabelsRequest": {
+ "id": "ZoneSetLabelsRequest",
+ "type": "object",
+ "properties": {
+ "labelFingerprint": {
+ "type": "string",
+ "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.",
+ "format": "byte"
+ },
+ "labels": {
+ "type": "object",
+ "description": "The labels to set for this resource.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
}
},
"resources": {
@@ -9716,6 +10054,50 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
+ },
+ "setLabels": {
+ "id": "compute.disks.setLabels",
+ "path": "{project}/zones/{zone}/disks/{resource}/setLabels",
+ "httpMethod": "POST",
+ "description": "Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "request": {
+ "$ref": "ZoneSetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
}
}
},
@@ -11591,6 +11973,42 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "setLabels": {
+ "id": "compute.images.setLabels",
+ "path": "{project}/global/images/{resource}/setLabels",
+ "httpMethod": "POST",
+ "description": "Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
}
}
},
@@ -11600,7 +12018,7 @@
"id": "compute.instanceGroupManagers.abandonInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -11730,7 +12148,7 @@
"id": "compute.instanceGroupManagers.deleteInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -11812,7 +12230,7 @@
"id": "compute.instanceGroupManagers.insert",
"path": "{project}/zones/{zone}/instanceGroupManagers",
"httpMethod": "POST",
- "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group.",
+ "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.",
"parameters": {
"project": {
"type": "string",
@@ -11962,7 +12380,7 @@
"id": "compute.instanceGroupManagers.recreateInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -12004,7 +12422,7 @@
"id": "compute.instanceGroupManagers.resize",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
"httpMethod": "POST",
- "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -12466,7 +12884,7 @@
"id": "compute.instanceGroups.removeInstances",
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
"httpMethod": "POST",
- "description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
+ "description": "Removes one or more instances from the specified instance group, but does not delete those instances.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.",
"parameters": {
"instanceGroup": {
"type": "string",
@@ -13275,6 +13693,50 @@
"https://www.googleapis.com/auth/compute"
]
},
+ "setLabels": {
+ "id": "compute.instances.setLabels",
+ "path": "{project}/zones/{zone}/instances/{instance}/setLabels",
+ "httpMethod": "POST",
+ "description": "Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.",
+ "parameters": {
+ "instance": {
+ "type": "string",
+ "description": "Name of the instance scoping this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "request": {
+ "$ref": "InstancesSetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
"setMachineType": {
"id": "compute.instances.setMachineType",
"path": "{project}/zones/{zone}/instances/{instance}/setMachineType",
@@ -13996,6 +14458,112 @@
},
"projects": {
"methods": {
+ "disableXpnHost": {
+ "id": "compute.projects.disableXpnHost",
+ "path": "{project}/disableXpnHost",
+ "httpMethod": "POST",
+ "description": "Disable this project as an XPN host project.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "disableXpnResource": {
+ "id": "compute.projects.disableXpnResource",
+ "path": "{project}/disableXpnResource",
+ "httpMethod": "POST",
+ "description": "Disable an XPN resource associated with this host project.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "request": {
+ "$ref": "ProjectsDisableXpnResourceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "enableXpnHost": {
+ "id": "compute.projects.enableXpnHost",
+ "path": "{project}/enableXpnHost",
+ "httpMethod": "POST",
+ "description": "Enable this project as an XPN host project.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "enableXpnResource": {
+ "id": "compute.projects.enableXpnResource",
+ "path": "{project}/enableXpnResource",
+ "httpMethod": "POST",
+ "description": "Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "request": {
+ "$ref": "ProjectsEnableXpnResourceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
"get": {
"id": "compute.projects.get",
"path": "{project}",
@@ -14022,6 +14590,125 @@
"https://www.googleapis.com/auth/compute.readonly"
]
},
+ "getXpnHost": {
+ "id": "compute.projects.getXpnHost",
+ "path": "{project}/getXpnHost",
+ "httpMethod": "GET",
+ "description": "Get the XPN host project that this project links to. May be empty if no link exists.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "getXpnResources": {
+ "id": "compute.projects.getXpnResources",
+ "path": "{project}/getXpnResources",
+ "httpMethod": "GET",
+ "description": "Get XPN resources associated with this host project.",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "type": "integer",
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "location": "query"
+ },
+ "order_by": {
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "ProjectsGetXpnResources"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "listXpnHosts": {
+ "id": "compute.projects.listXpnHosts",
+ "path": "{project}/listXpnHosts",
+ "httpMethod": "POST",
+ "description": "List all XPN host projects visible to the user in an organization.",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "type": "integer",
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "location": "query"
+ },
+ "order_by": {
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "request": {
+ "$ref": "ProjectsListXpnHostsRequest"
+ },
+ "response": {
+ "$ref": "XpnHostList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
"moveDisk": {
"id": "compute.projects.moveDisk",
"path": "{project}/moveDisk",
@@ -14723,7 +15410,7 @@
"id": "compute.regionInstanceGroupManagers.abandonInstances",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -14804,7 +15491,7 @@
"id": "compute.regionInstanceGroupManagers.deleteInstances",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -15036,7 +15723,7 @@
"id": "compute.regionInstanceGroupManagers.recreateInstances",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"httpMethod": "POST",
- "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -15078,7 +15765,7 @@
"id": "compute.regionInstanceGroupManagers.resize",
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize",
"httpMethod": "POST",
- "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
"parameters": {
"instanceGroupManager": {
"type": "string",
@@ -16314,6 +17001,42 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+ },
+ "setLabels": {
+ "id": "compute.snapshots.setLabels",
+ "path": "{project}/global/snapshots/{resource}/setLabels",
+ "httpMethod": "POST",
+ "description": "Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
}
}
},
@@ -18171,6 +18894,226 @@
}
}
},
+ "targetTcpProxies": {
+ "methods": {
+ "delete": {
+ "id": "compute.targetTcpProxies.delete",
+ "path": "{project}/global/targetTcpProxies/{targetTcpProxy}",
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified TargetTcpProxy resource.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "targetTcpProxy": {
+ "type": "string",
+ "description": "Name of the TargetTcpProxy resource to delete.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "targetTcpProxy"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "get": {
+ "id": "compute.targetTcpProxies.get",
+ "path": "{project}/global/targetTcpProxies/{targetTcpProxy}",
+ "httpMethod": "GET",
+ "description": "Returns the specified TargetTcpProxy resource. Get a list of available target TCP proxies by making a list() request.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "targetTcpProxy": {
+ "type": "string",
+ "description": "Name of the TargetTcpProxy resource to return.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "targetTcpProxy"
+ ],
+ "response": {
+ "$ref": "TargetTcpProxy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "insert": {
+ "id": "compute.targetTcpProxies.insert",
+ "path": "{project}/global/targetTcpProxies",
+ "httpMethod": "POST",
+ "description": "Creates a TargetTcpProxy resource in the specified project using the data included in the request.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "request": {
+ "$ref": "TargetTcpProxy"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "list": {
+ "id": "compute.targetTcpProxies.list",
+ "path": "{project}/global/targetTcpProxies",
+ "httpMethod": "GET",
+ "description": "Retrieves the list of TargetTcpProxy resources available to the specified project.",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
+ "location": "query"
+ },
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)",
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "location": "query"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "TargetTcpProxyList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "setBackendService": {
+ "id": "compute.targetTcpProxies.setBackendService",
+ "path": "{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService",
+ "httpMethod": "POST",
+ "description": "Changes the BackendService for TargetTcpProxy.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "targetTcpProxy": {
+ "type": "string",
+ "description": "Name of the TargetTcpProxy resource whose BackendService resource is to be set.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "targetTcpProxy"
+ ],
+ "request": {
+ "$ref": "TargetTcpProxiesSetBackendServiceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "setProxyHeader": {
+ "id": "compute.targetTcpProxies.setProxyHeader",
+ "path": "{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader",
+ "httpMethod": "POST",
+ "description": "Changes the ProxyHeaderType for TargetTcpProxy.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "targetTcpProxy": {
+ "type": "string",
+ "description": "Name of the TargetTcpProxy resource whose ProxyHeader is to be set.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "targetTcpProxy"
+ ],
+ "request": {
+ "$ref": "TargetTcpProxiesSetProxyHeaderRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ }
+ }
+ },
"targetVpnGateways": {
"methods": {
"aggregatedList": {
diff --git a/compute/v1/compute-gen.go b/compute/v1/compute-gen.go
index 87a58c6..d6a5136 100644
--- a/compute/v1/compute-gen.go
+++ b/compute/v1/compute-gen.go
@@ -110,6 +110,7 @@
s.TargetInstances = NewTargetInstancesService(s)
s.TargetPools = NewTargetPoolsService(s)
s.TargetSslProxies = NewTargetSslProxiesService(s)
+ s.TargetTcpProxies = NewTargetTcpProxiesService(s)
s.TargetVpnGateways = NewTargetVpnGatewaysService(s)
s.UrlMaps = NewUrlMapsService(s)
s.VpnTunnels = NewVpnTunnelsService(s)
@@ -201,6 +202,8 @@
TargetSslProxies *TargetSslProxiesService
+ TargetTcpProxies *TargetTcpProxiesService
+
TargetVpnGateways *TargetVpnGatewaysService
UrlMaps *UrlMapsService
@@ -570,6 +573,15 @@
s *Service
}
+func NewTargetTcpProxiesService(s *Service) *TargetTcpProxiesService {
+ rs := &TargetTcpProxiesService{s: s}
+ return rs
+}
+
+type TargetTcpProxiesService struct {
+ s *Service
+}
+
func NewTargetVpnGatewaysService(s *Service) *TargetVpnGatewaysService {
rs := &TargetVpnGatewaysService{s: s}
return rs
@@ -2741,6 +2753,21 @@
// disks.
Kind string `json:"kind,omitempty"`
+ // LabelFingerprint: A fingerprint for the labels being applied to this
+ // disk, which is essentially a hash of the labels set used for
+ // optimistic locking. The fingerprint is initially generated by Compute
+ // Engine and changes after every request to modify or update labels.
+ // You must always provide an up-to-date fingerprint hash in order to
+ // update or change labels.
+ //
+ // To see the latest fingerprint, make a get() request to retrieve a
+ // disk.
+ LabelFingerprint string `json:"labelFingerprint,omitempty"`
+
+ // Labels: Labels to apply to this disk. These can be later modified by
+ // the setLabels method.
+ Labels map[string]string `json:"labels,omitempty"`
+
// LastAttachTimestamp: [Output Only] Last attach timestamp in RFC3339
// text format.
LastAttachTimestamp string `json:"lastAttachTimestamp,omitempty"`
@@ -3683,15 +3710,16 @@
// For global forwarding rules, the address must be a global IP. For
// regional forwarding rules, the address must live in the same region
// as the forwarding rule. By default, this field is empty and an
- // ephemeral IP from the same scope (global or regional) will be
- // assigned.
+ // ephemeral IPv4 address from the same scope (global or regional) will
+ // be assigned. A regional forwarding rule supports IPv4 only. A global
+ // forwarding rule supports either IPv4 or IPv6.
//
// When the load balancing scheme is INTERNAL, this can only be an RFC
// 1918 IP address belonging to the network/subnetwork configured for
// the forwarding rule. A reserved address cannot be used. If the field
// is empty, the IP address will be automatically allocated from the
// internal IP range of the subnetwork or network configured for this
- // forwarding rule. Only IPv4 is supported.
+ // forwarding rule.
IPAddress string `json:"IPAddress,omitempty"`
// IPProtocol: The IP protocol to which this rule applies. Valid options
@@ -4073,6 +4101,49 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type GlobalSetLabelsRequest struct {
+ // LabelFingerprint: The fingerprint of the previous set of labels for
+ // this resource, used to detect conflicts. The fingerprint is initially
+ // generated by Compute Engine and changes after every request to modify
+ // or update labels. You must always provide an up-to-date fingerprint
+ // hash when updating or changing labels. Make a get() request to the
+ // resource to get the latest fingerprint.
+ LabelFingerprint string `json:"labelFingerprint,omitempty"`
+
+ // Labels: A list of labels to apply for this resource. Each label key &
+ // value must comply with RFC1035. Specifically, the name must be 1-63
+ // characters long and match the regular expression
+ // [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a
+ // lowercase letter, and all following characters must be a dash,
+ // lowercase letter, or digit, except the last character, which cannot
+ // be a dash. For example, "webserver-frontend": "images". A label value
+ // can also be empty (e.g. "my-label": "").
+ Labels map[string]string `json:"labels,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "LabelFingerprint") 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. "LabelFingerprint") 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 *GlobalSetLabelsRequest) MarshalJSON() ([]byte, error) {
+ type noMethod GlobalSetLabelsRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// GuestOsFeature: Guest OS features.
type GuestOsFeature struct {
// Type: The type of supported feature. Currenty only
@@ -4816,6 +4887,21 @@
// images.
Kind string `json:"kind,omitempty"`
+ // LabelFingerprint: A fingerprint for the labels being applied to this
+ // image, which is essentially a hash of the labels used for optimistic
+ // locking. The fingerprint is initially generated by Compute Engine and
+ // changes after every request to modify or update labels. You must
+ // always provide an up-to-date fingerprint hash in order to update or
+ // change labels.
+ //
+ // To see the latest fingerprint, make a get() request to retrieve an
+ // image.
+ LabelFingerprint string `json:"labelFingerprint,omitempty"`
+
+ // Labels: Labels to apply to this image. These can be later modified by
+ // the setLabels method.
+ Labels map[string]string `json:"labels,omitempty"`
+
// Licenses: Any applicable license URI.
Licenses []string `json:"licenses,omitempty"`
@@ -5024,6 +5110,20 @@
// instances.
Kind string `json:"kind,omitempty"`
+ // LabelFingerprint: A fingerprint for this request, which is
+ // essentially a hash of the metadata's contents and used for optimistic
+ // locking. The fingerprint is initially generated by Compute Engine and
+ // changes after every request to modify or update metadata. You must
+ // always provide an up-to-date fingerprint hash in order to update or
+ // change metadata.
+ //
+ // To see the latest fingerprint, make get() request to the instance.
+ LabelFingerprint string `json:"labelFingerprint,omitempty"`
+
+ // Labels: Labels to apply to this instance. These can be later modified
+ // by the setLabels method.
+ Labels map[string]string `json:"labels,omitempty"`
+
// MachineType: Full or partial URL of the machine type resource to use
// for this instance, in the format:
// zones/zone/machineTypes/machine-type. This is provided by the client
@@ -5083,6 +5183,10 @@
// instance. See Service Accounts for more information.
ServiceAccounts []*ServiceAccount `json:"serviceAccounts,omitempty"`
+ // StartRestricted: [Output Only] Whether a VM has been restricted for
+ // start because Compute Engine has detected suspicious activity.
+ StartRestricted bool `json:"startRestricted,omitempty"`
+
// Status: [Output Only] The status of the instance. One of the
// following values: PROVISIONING, STAGING, RUNNING, STOPPING,
// SUSPENDING, SUSPENDED, and TERMINATED.
@@ -6388,8 +6492,8 @@
// receive packets with destination IP addresses other than their own.
// If these instances will be used as an IP gateway or it will be set as
// the next-hop in a Route resource, specify true. If unsure, leave this
- // set to false. See the Enable IP forwarding for instances
- // documentation for more information.
+ // set to false. See the Enable IP forwarding documentation for more
+ // information.
CanIpForward bool `json:"canIpForward,omitempty"`
// Description: An optional text description for the instances that are
@@ -6400,6 +6504,10 @@
// are created from this template.
Disks []*AttachedDisk `json:"disks,omitempty"`
+ // Labels: Labels to apply to instances that are created from this
+ // template.
+ Labels map[string]string `json:"labels,omitempty"`
+
// MachineType: The machine type to use for instances that are created
// from this template.
MachineType string `json:"machineType,omitempty"`
@@ -6765,6 +6873,38 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type InstancesSetLabelsRequest struct {
+ // LabelFingerprint: Fingerprint of the previous set of labels for this
+ // resource, used to prevent conflicts. Provide the latest fingerprint
+ // value when making a request to add or change labels.
+ LabelFingerprint string `json:"labelFingerprint,omitempty"`
+
+ Labels map[string]string `json:"labels,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "LabelFingerprint") 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. "LabelFingerprint") 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 *InstancesSetLabelsRequest) MarshalJSON() ([]byte, error) {
+ type noMethod InstancesSetLabelsRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type InstancesSetMachineTypeRequest struct {
// MachineType: Full or partial URL of the machine type resource. See
// Machine Types for a full list of machine types. For example:
@@ -8390,6 +8530,15 @@
// the Google Cloud Storage bucket where they are stored.
UsageExportLocation *UsageExportLocation `json:"usageExportLocation,omitempty"`
+ // XpnProjectStatus: [Output Only] The role this project has in a Cross
+ // Project Network (XPN) configuration. Currently only HOST projects are
+ // differentiated.
+ //
+ // Possible values:
+ // "HOST"
+ // "UNSPECIFIED_XPN_PROJECT_STATUS"
+ XpnProjectStatus string `json:"xpnProjectStatus,omitempty"`
+
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
@@ -8419,6 +8568,132 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type ProjectsDisableXpnResourceRequest struct {
+ // XpnResource: XPN resource ID.
+ XpnResource *XpnResourceId `json:"xpnResource,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "XpnResource") 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. "XpnResource") 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 *ProjectsDisableXpnResourceRequest) MarshalJSON() ([]byte, error) {
+ type noMethod ProjectsDisableXpnResourceRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+type ProjectsEnableXpnResourceRequest struct {
+ // XpnResource: XPN resource ID.
+ XpnResource *XpnResourceId `json:"xpnResource,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "XpnResource") 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. "XpnResource") 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 *ProjectsEnableXpnResourceRequest) MarshalJSON() ([]byte, error) {
+ type noMethod ProjectsEnableXpnResourceRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+type ProjectsGetXpnResources struct {
+ // Kind: [Output Only] Type of resource. Always
+ // compute#projectsGetXpnResources for lists of XPN resources.
+ Kind string `json:"kind,omitempty"`
+
+ // NextPageToken: [Output Only] This token allows you to get the next
+ // page of results for list requests. If the number of results is larger
+ // than maxResults, use the nextPageToken as a value for the query
+ // parameter pageToken in the next list request. Subsequent list
+ // requests will have their own nextPageToken to continue paging through
+ // the results.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // Resources: XPN resources attached to this project as their XPN host.
+ Resources []*XpnResourceId `json:"resources,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Kind") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Kind") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ProjectsGetXpnResources) MarshalJSON() ([]byte, error) {
+ type noMethod ProjectsGetXpnResources
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+type ProjectsListXpnHostsRequest struct {
+ // Organization: Optional organization ID managed by Cloud Resource
+ // Manager, for which to list XPN host projects. If not specified, the
+ // organization will be inferred from the project.
+ Organization string `json:"organization,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Organization") 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. "Organization") 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 *ProjectsListXpnHostsRequest) MarshalJSON() ([]byte, error) {
+ type noMethod ProjectsListXpnHostsRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Quota: A quotas entry.
type Quota struct {
// Limit: [Output Only] Quota limit for this metric.
@@ -10166,6 +10441,21 @@
// Snapshot resources.
Kind string `json:"kind,omitempty"`
+ // LabelFingerprint: A fingerprint for the labels being applied to this
+ // snapshot, which is essentially a hash of the labels set used for
+ // optimistic locking. The fingerprint is initially generated by Compute
+ // Engine and changes after every request to modify or update labels.
+ // You must always provide an up-to-date fingerprint hash in order to
+ // update or change labels.
+ //
+ // To see the latest fingerprint, make a get() request to retrieve a
+ // snapshot.
+ LabelFingerprint string `json:"labelFingerprint,omitempty"`
+
+ // Labels: Labels to apply to this snapshot. These can be later modified
+ // by the setLabels method. Label values may be empty.
+ Labels map[string]string `json:"labels,omitempty"`
+
// Licenses: [Output Only] A list of public visible licenses that apply
// to this snapshot. This can be because the original image had licenses
// attached (such as a Windows image).
@@ -10444,11 +10734,13 @@
CreationTimestamp string `json:"creationTimestamp,omitempty"`
// Description: An optional description of this resource. Provide this
- // property when you create the resource.
+ // property when you create the resource. This field can be set only at
+ // resource creation time.
Description string `json:"description,omitempty"`
// GatewayAddress: [Output Only] The gateway address for default routes
- // to reach destination addresses outside this subnetwork.
+ // to reach destination addresses outside this subnetwork. This field
+ // can be set only at resource creation time.
GatewayAddress string `json:"gatewayAddress,omitempty"`
// Id: [Output Only] The unique identifier for the resource. This
@@ -10458,7 +10750,8 @@
// IpCidrRange: The range of internal addresses that are owned by this
// subnetwork. Provide this property when you create the subnetwork. For
// example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and
- // non-overlapping within a network. Only IPv4 is supported.
+ // non-overlapping within a network. Only IPv4 is supported. This field
+ // can be set only at resource creation time.
IpCidrRange string `json:"ipCidrRange,omitempty"`
// Kind: [Output Only] Type of the resource. Always compute#subnetwork
@@ -10476,14 +10769,18 @@
// Network: The URL of the network to which this subnetwork belongs,
// provided by the client when initially creating the subnetwork. Only
- // networks that are in the distributed mode can have subnetworks.
+ // networks that are in the distributed mode can have subnetworks. This
+ // field can be set only at resource creation time.
Network string `json:"network,omitempty"`
// PrivateIpGoogleAccess: Whether the VMs in this subnet can access
- // Google services without assigned external IP addresses.
+ // Google services without assigned external IP addresses. This field
+ // can be both set at resource creation time and updated using
+ // setPrivateIpGoogleAccess.
PrivateIpGoogleAccess bool `json:"privateIpGoogleAccess,omitempty"`
- // Region: URL of the region where the Subnetwork resides.
+ // Region: URL of the region where the Subnetwork resides. This field
+ // can be set only at resource creation time.
Region string `json:"region,omitempty"`
// SelfLink: [Output Only] Server-defined URL for the resource.
@@ -12238,6 +12535,187 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type TargetTcpProxiesSetBackendServiceRequest struct {
+ // Service: The URL of the new BackendService resource for the
+ // targetTcpProxy.
+ Service string `json:"service,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Service") 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. "Service") 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 *TargetTcpProxiesSetBackendServiceRequest) MarshalJSON() ([]byte, error) {
+ type noMethod TargetTcpProxiesSetBackendServiceRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+type TargetTcpProxiesSetProxyHeaderRequest struct {
+ // ProxyHeader: The new type of proxy header to append before sending
+ // data to the backend. NONE or PROXY_V1 are allowed.
+ //
+ // Possible values:
+ // "NONE"
+ // "PROXY_V1"
+ ProxyHeader string `json:"proxyHeader,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ProxyHeader") 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. "ProxyHeader") 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 *TargetTcpProxiesSetProxyHeaderRequest) MarshalJSON() ([]byte, error) {
+ type noMethod TargetTcpProxiesSetProxyHeaderRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// TargetTcpProxy: A TargetTcpProxy resource. This resource defines a
+// TCP proxy.
+type TargetTcpProxy struct {
+ // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
+ // format.
+ CreationTimestamp string `json:"creationTimestamp,omitempty"`
+
+ // Description: An optional description of this resource. Provide this
+ // property when you create the resource.
+ Description string `json:"description,omitempty"`
+
+ // Id: [Output Only] The unique identifier for the resource. This
+ // identifier is defined by the server.
+ Id uint64 `json:"id,omitempty,string"`
+
+ // Kind: [Output Only] Type of the resource. Always
+ // compute#targetTcpProxy for target TCP proxies.
+ Kind string `json:"kind,omitempty"`
+
+ // Name: Name of the resource. Provided by the client when the resource
+ // is created. The name must be 1-63 characters long, and comply with
+ // RFC1035. Specifically, the name must be 1-63 characters long and
+ // match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means
+ // the first character must be a lowercase letter, and all following
+ // characters must be a dash, lowercase letter, or digit, except the
+ // last character, which cannot be a dash.
+ Name string `json:"name,omitempty"`
+
+ // ProxyHeader: Specifies the type of proxy header to append before
+ // sending data to the backend, either NONE or PROXY_V1. The default is
+ // NONE.
+ //
+ // Possible values:
+ // "NONE"
+ // "PROXY_V1"
+ ProxyHeader string `json:"proxyHeader,omitempty"`
+
+ // SelfLink: [Output Only] Server-defined URL for the resource.
+ SelfLink string `json:"selfLink,omitempty"`
+
+ // Service: URL to the BackendService resource.
+ Service string `json:"service,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "CreationTimestamp")
+ // 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. "CreationTimestamp") 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 *TargetTcpProxy) MarshalJSON() ([]byte, error) {
+ type noMethod TargetTcpProxy
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// TargetTcpProxyList: Contains a list of TargetTcpProxy resources.
+type TargetTcpProxyList struct {
+ // Id: [Output Only] The unique identifier for the resource. This
+ // identifier is defined by the server.
+ Id string `json:"id,omitempty"`
+
+ // Items: A list of TargetTcpProxy resources.
+ Items []*TargetTcpProxy `json:"items,omitempty"`
+
+ // Kind: Type of resource.
+ Kind string `json:"kind,omitempty"`
+
+ // NextPageToken: [Output Only] This token allows you to get the next
+ // page of results for list requests. If the number of results is larger
+ // than maxResults, use the nextPageToken as a value for the query
+ // parameter pageToken in the next list request. Subsequent list
+ // requests will have their own nextPageToken to continue paging through
+ // the results.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // SelfLink: [Output Only] Server-defined URL for this resource.
+ SelfLink string `json:"selfLink,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Id") 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. "Id") 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 *TargetTcpProxyList) MarshalJSON() ([]byte, error) {
+ type noMethod TargetTcpProxyList
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// TargetVpnGateway: Represents a Target VPN gateway resource.
type TargetVpnGateway struct {
// CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
@@ -13261,6 +13739,92 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type XpnHostList struct {
+ // Id: [Output Only] The unique identifier for the resource. This
+ // identifier is defined by the server.
+ Id string `json:"id,omitempty"`
+
+ // Items: [Output Only] A list of XPN host project URLs.
+ Items []*Project `json:"items,omitempty"`
+
+ // Kind: [Output Only] Type of resource. Always compute#xpnHostList for
+ // lists of XPN hosts.
+ Kind string `json:"kind,omitempty"`
+
+ // NextPageToken: [Output Only] This token allows you to get the next
+ // page of results for list requests. If the number of results is larger
+ // than maxResults, use the nextPageToken as a value for the query
+ // parameter pageToken in the next list request. Subsequent list
+ // requests will have their own nextPageToken to continue paging through
+ // the results.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // SelfLink: [Output Only] Server-defined URL for this resource.
+ SelfLink string `json:"selfLink,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Id") 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. "Id") 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 *XpnHostList) MarshalJSON() ([]byte, error) {
+ type noMethod XpnHostList
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// XpnResourceId: XpnResourceId
+type XpnResourceId struct {
+ // Id: The ID of the XPN resource. In the case of projects, this field
+ // matches the project's name, not the canonical ID.
+ Id string `json:"id,omitempty"`
+
+ // Type: The type of the XPN resource.
+ //
+ // Possible values:
+ // "PROJECT"
+ // "XPN_RESOURCE_TYPE_UNSPECIFIED"
+ Type string `json:"type,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Id") 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. "Id") 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 *XpnResourceId) MarshalJSON() ([]byte, error) {
+ type noMethod XpnResourceId
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Zone: A Zone resource.
type Zone struct {
// CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text
@@ -13377,6 +13941,42 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type ZoneSetLabelsRequest struct {
+ // LabelFingerprint: The fingerprint of the previous set of labels for
+ // this resource, used to detect conflicts. The fingerprint is initially
+ // generated by Compute Engine and changes after every request to modify
+ // or update labels. You must always provide an up-to-date fingerprint
+ // hash in order to update or change labels. Make a get() request to the
+ // resource to get the latest fingerprint.
+ LabelFingerprint string `json:"labelFingerprint,omitempty"`
+
+ // Labels: The labels to set for this resource.
+ Labels map[string]string `json:"labels,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "LabelFingerprint") 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. "LabelFingerprint") 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 *ZoneSetLabelsRequest) MarshalJSON() ([]byte, error) {
+ type noMethod ZoneSetLabelsRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// method id "compute.addresses.aggregatedList":
type AddressesAggregatedListCall struct {
@@ -20008,6 +20608,164 @@
}
+// method id "compute.disks.setLabels":
+
+type DisksSetLabelsCall struct {
+ s *Service
+ project string
+ zone string
+ resource string
+ zonesetlabelsrequest *ZoneSetLabelsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetLabels: Sets the labels on a disk. To learn more about labels,
+// read the Labeling or Tagging Resources documentation.
+func (r *DisksService) SetLabels(project string, zone string, resource string, zonesetlabelsrequest *ZoneSetLabelsRequest) *DisksSetLabelsCall {
+ c := &DisksSetLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.zone = zone
+ c.resource = resource
+ c.zonesetlabelsrequest = zonesetlabelsrequest
+ 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 *DisksSetLabelsCall) Fields(s ...googleapi.Field) *DisksSetLabelsCall {
+ 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 *DisksSetLabelsCall) Context(ctx context.Context) *DisksSetLabelsCall {
+ 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 *DisksSetLabelsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *DisksSetLabelsCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.zonesetlabelsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/disks/{resource}/setLabels")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ "zone": c.zone,
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.disks.setLabels" 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 *DisksSetLabelsCall) 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": "Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.",
+ // "httpMethod": "POST",
+ // "id": "compute.disks.setLabels",
+ // "parameterOrder": [
+ // "project",
+ // "zone",
+ // "resource"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "resource": {
+ // "description": "Name of the resource for this request.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the zone for this request.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/zones/{zone}/disks/{resource}/setLabels",
+ // "request": {
+ // "$ref": "ZoneSetLabelsRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
// method id "compute.firewalls.delete":
type FirewallsDeleteCall struct {
@@ -28318,6 +29076,153 @@
}
}
+// method id "compute.images.setLabels":
+
+type ImagesSetLabelsCall struct {
+ s *Service
+ project string
+ resource string
+ globalsetlabelsrequest *GlobalSetLabelsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetLabels: Sets the labels on an image. To learn more about labels,
+// read the Labeling or Tagging Resources documentation.
+func (r *ImagesService) SetLabels(project string, resource string, globalsetlabelsrequest *GlobalSetLabelsRequest) *ImagesSetLabelsCall {
+ c := &ImagesSetLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.resource = resource
+ c.globalsetlabelsrequest = globalsetlabelsrequest
+ 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 *ImagesSetLabelsCall) Fields(s ...googleapi.Field) *ImagesSetLabelsCall {
+ 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 *ImagesSetLabelsCall) Context(ctx context.Context) *ImagesSetLabelsCall {
+ 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 *ImagesSetLabelsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ImagesSetLabelsCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.globalsetlabelsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/images/{resource}/setLabels")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.images.setLabels" 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 *ImagesSetLabelsCall) 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": "Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.",
+ // "httpMethod": "POST",
+ // "id": "compute.images.setLabels",
+ // "parameterOrder": [
+ // "project",
+ // "resource"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "resource": {
+ // "description": "Name of the resource for this request.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/global/images/{resource}/setLabels",
+ // "request": {
+ // "$ref": "GlobalSetLabelsRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
// method id "compute.instanceGroupManagers.abandonInstances":
type InstanceGroupManagersAbandonInstancesCall struct {
@@ -28341,6 +29246,11 @@
// been removed from the group. You must separately verify the status of
// the abandoning action with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *InstanceGroupManagersService) AbandonInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersabandoninstancesrequest *InstanceGroupManagersAbandonInstancesRequest) *InstanceGroupManagersAbandonInstancesCall {
@@ -28440,7 +29350,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.abandonInstances",
// "parameterOrder": [
@@ -28908,6 +29818,11 @@
// deleted. You must separately verify the status of the deleting action
// with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *InstanceGroupManagersService) DeleteInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersdeleteinstancesrequest *InstanceGroupManagersDeleteInstancesRequest) *InstanceGroupManagersDeleteInstancesCall {
@@ -29007,7 +29922,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.deleteInstances",
// "parameterOrder": [
@@ -29234,6 +30149,7 @@
// with the listmanagedinstances method.
//
// A managed instance group can have up to 1000 VM instances per group.
+// Please contact Cloud Support if you need an increase in this limit.
func (r *InstanceGroupManagersService) Insert(project string, zone string, instancegroupmanager *InstanceGroupManager) *InstanceGroupManagersInsertCall {
c := &InstanceGroupManagersInsertCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -29329,7 +30245,7 @@
}
return ret, nil
// {
- // "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group.",
+ // "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.insert",
// "parameterOrder": [
@@ -29846,6 +30762,11 @@
// separately verify the status of the recreating action with the
// listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *InstanceGroupManagersService) RecreateInstances(project string, zone string, instanceGroupManager string, instancegroupmanagersrecreateinstancesrequest *InstanceGroupManagersRecreateInstancesRequest) *InstanceGroupManagersRecreateInstancesCall {
@@ -29945,7 +30866,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.recreateInstances",
// "parameterOrder": [
@@ -30008,6 +30929,10 @@
// if the group has not yet added or deleted any instances. You must
// separately verify the status of the creating or deleting actions with
// the listmanagedinstances method.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or deleted.
func (r *InstanceGroupManagersService) Resize(project string, zone string, instanceGroupManager string, size int64) *InstanceGroupManagersResizeCall {
c := &InstanceGroupManagersResizeCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -30100,7 +31025,7 @@
}
return ret, nil
// {
- // "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ // "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.instanceGroupManagers.resize",
// "parameterOrder": [
@@ -31878,6 +32803,10 @@
// RemoveInstances: Removes one or more instances from the specified
// instance group, but does not delete those instances.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration before the VM instance is removed or deleted.
func (r *InstanceGroupsService) RemoveInstances(project string, zone string, instanceGroup string, instancegroupsremoveinstancesrequest *InstanceGroupsRemoveInstancesRequest) *InstanceGroupsRemoveInstancesCall {
c := &InstanceGroupsRemoveInstancesCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -31975,7 +32904,7 @@
}
return ret, nil
// {
- // "description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
+ // "description": "Removes one or more instances from the specified instance group, but does not delete those instances.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.instanceGroups.removeInstances",
// "parameterOrder": [
@@ -35002,6 +35931,164 @@
}
+// method id "compute.instances.setLabels":
+
+type InstancesSetLabelsCall struct {
+ s *Service
+ project string
+ zone string
+ instance string
+ instancessetlabelsrequest *InstancesSetLabelsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetLabels: Sets labels on an instance. To learn more about labels,
+// read the Labeling or Tagging Resources documentation.
+func (r *InstancesService) SetLabels(project string, zone string, instance string, instancessetlabelsrequest *InstancesSetLabelsRequest) *InstancesSetLabelsCall {
+ c := &InstancesSetLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.zone = zone
+ c.instance = instance
+ c.instancessetlabelsrequest = instancessetlabelsrequest
+ 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 *InstancesSetLabelsCall) Fields(s ...googleapi.Field) *InstancesSetLabelsCall {
+ 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 *InstancesSetLabelsCall) Context(ctx context.Context) *InstancesSetLabelsCall {
+ 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 *InstancesSetLabelsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *InstancesSetLabelsCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.instancessetlabelsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/zones/{zone}/instances/{instance}/setLabels")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ "zone": c.zone,
+ "instance": c.instance,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.instances.setLabels" 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 *InstancesSetLabelsCall) 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": "Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.",
+ // "httpMethod": "POST",
+ // "id": "compute.instances.setLabels",
+ // "parameterOrder": [
+ // "project",
+ // "zone",
+ // "instance"
+ // ],
+ // "parameters": {
+ // "instance": {
+ // "description": "Name of the instance scoping this request.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the zone for this request.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/zones/{zone}/instances/{instance}/setLabels",
+ // "request": {
+ // "$ref": "InstancesSetLabelsRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
// method id "compute.instances.setMachineType":
type InstancesSetMachineTypeCall struct {
@@ -37911,6 +38998,530 @@
}
+// method id "compute.projects.disableXpnHost":
+
+type ProjectsDisableXpnHostCall struct {
+ s *Service
+ project string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// DisableXpnHost: Disable this project as an XPN host project.
+func (r *ProjectsService) DisableXpnHost(project string) *ProjectsDisableXpnHostCall {
+ c := &ProjectsDisableXpnHostCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ 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 *ProjectsDisableXpnHostCall) Fields(s ...googleapi.Field) *ProjectsDisableXpnHostCall {
+ 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 *ProjectsDisableXpnHostCall) Context(ctx context.Context) *ProjectsDisableXpnHostCall {
+ 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 *ProjectsDisableXpnHostCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsDisableXpnHostCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/disableXpnHost")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.projects.disableXpnHost" 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 *ProjectsDisableXpnHostCall) 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": "Disable this project as an XPN host project.",
+ // "httpMethod": "POST",
+ // "id": "compute.projects.disableXpnHost",
+ // "parameterOrder": [
+ // "project"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/disableXpnHost",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
+// method id "compute.projects.disableXpnResource":
+
+type ProjectsDisableXpnResourceCall struct {
+ s *Service
+ project string
+ projectsdisablexpnresourcerequest *ProjectsDisableXpnResourceRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// DisableXpnResource: Disable an XPN resource associated with this host
+// project.
+func (r *ProjectsService) DisableXpnResource(project string, projectsdisablexpnresourcerequest *ProjectsDisableXpnResourceRequest) *ProjectsDisableXpnResourceCall {
+ c := &ProjectsDisableXpnResourceCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.projectsdisablexpnresourcerequest = projectsdisablexpnresourcerequest
+ 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 *ProjectsDisableXpnResourceCall) Fields(s ...googleapi.Field) *ProjectsDisableXpnResourceCall {
+ 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 *ProjectsDisableXpnResourceCall) Context(ctx context.Context) *ProjectsDisableXpnResourceCall {
+ 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 *ProjectsDisableXpnResourceCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsDisableXpnResourceCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.projectsdisablexpnresourcerequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/disableXpnResource")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.projects.disableXpnResource" 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 *ProjectsDisableXpnResourceCall) 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": "Disable an XPN resource associated with this host project.",
+ // "httpMethod": "POST",
+ // "id": "compute.projects.disableXpnResource",
+ // "parameterOrder": [
+ // "project"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/disableXpnResource",
+ // "request": {
+ // "$ref": "ProjectsDisableXpnResourceRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
+// method id "compute.projects.enableXpnHost":
+
+type ProjectsEnableXpnHostCall struct {
+ s *Service
+ project string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// EnableXpnHost: Enable this project as an XPN host project.
+func (r *ProjectsService) EnableXpnHost(project string) *ProjectsEnableXpnHostCall {
+ c := &ProjectsEnableXpnHostCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ 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 *ProjectsEnableXpnHostCall) Fields(s ...googleapi.Field) *ProjectsEnableXpnHostCall {
+ 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 *ProjectsEnableXpnHostCall) Context(ctx context.Context) *ProjectsEnableXpnHostCall {
+ 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 *ProjectsEnableXpnHostCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsEnableXpnHostCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/enableXpnHost")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.projects.enableXpnHost" 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 *ProjectsEnableXpnHostCall) 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": "Enable this project as an XPN host project.",
+ // "httpMethod": "POST",
+ // "id": "compute.projects.enableXpnHost",
+ // "parameterOrder": [
+ // "project"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/enableXpnHost",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
+// method id "compute.projects.enableXpnResource":
+
+type ProjectsEnableXpnResourceCall struct {
+ s *Service
+ project string
+ projectsenablexpnresourcerequest *ProjectsEnableXpnResourceRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// EnableXpnResource: Enable XPN resource (a.k.a service project or
+// service folder in the future) for a host project, so that subnetworks
+// in the host project can be used by instances in the service project
+// or folder.
+func (r *ProjectsService) EnableXpnResource(project string, projectsenablexpnresourcerequest *ProjectsEnableXpnResourceRequest) *ProjectsEnableXpnResourceCall {
+ c := &ProjectsEnableXpnResourceCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.projectsenablexpnresourcerequest = projectsenablexpnresourcerequest
+ 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 *ProjectsEnableXpnResourceCall) Fields(s ...googleapi.Field) *ProjectsEnableXpnResourceCall {
+ 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 *ProjectsEnableXpnResourceCall) Context(ctx context.Context) *ProjectsEnableXpnResourceCall {
+ 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 *ProjectsEnableXpnResourceCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsEnableXpnResourceCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.projectsenablexpnresourcerequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/enableXpnResource")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.projects.enableXpnResource" 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 *ProjectsEnableXpnResourceCall) 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": "Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.",
+ // "httpMethod": "POST",
+ // "id": "compute.projects.enableXpnResource",
+ // "parameterOrder": [
+ // "project"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/enableXpnResource",
+ // "request": {
+ // "$ref": "ProjectsEnableXpnResourceRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
// method id "compute.projects.get":
type ProjectsGetCall struct {
@@ -38052,6 +39663,552 @@
}
+// method id "compute.projects.getXpnHost":
+
+type ProjectsGetXpnHostCall struct {
+ s *Service
+ project string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetXpnHost: Get the XPN host project that this project links to. May
+// be empty if no link exists.
+func (r *ProjectsService) GetXpnHost(project string) *ProjectsGetXpnHostCall {
+ c := &ProjectsGetXpnHostCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ 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 *ProjectsGetXpnHostCall) Fields(s ...googleapi.Field) *ProjectsGetXpnHostCall {
+ 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 *ProjectsGetXpnHostCall) IfNoneMatch(entityTag string) *ProjectsGetXpnHostCall {
+ 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 *ProjectsGetXpnHostCall) Context(ctx context.Context) *ProjectsGetXpnHostCall {
+ 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 *ProjectsGetXpnHostCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsGetXpnHostCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/getXpnHost")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.projects.getXpnHost" call.
+// Exactly one of *Project or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Project.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 *ProjectsGetXpnHostCall) Do(opts ...googleapi.CallOption) (*Project, 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 := &Project{
+ 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 XPN host project that this project links to. May be empty if no link exists.",
+ // "httpMethod": "GET",
+ // "id": "compute.projects.getXpnHost",
+ // "parameterOrder": [
+ // "project"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/getXpnHost",
+ // "response": {
+ // "$ref": "Project"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute",
+ // "https://www.googleapis.com/auth/compute.readonly"
+ // ]
+ // }
+
+}
+
+// method id "compute.projects.getXpnResources":
+
+type ProjectsGetXpnResourcesCall struct {
+ s *Service
+ project string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetXpnResources: Get XPN resources associated with this host project.
+func (r *ProjectsService) GetXpnResources(project string) *ProjectsGetXpnResourcesCall {
+ c := &ProjectsGetXpnResourcesCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ return c
+}
+
+// Filter sets the optional parameter "filter":
+func (c *ProjectsGetXpnResourcesCall) Filter(filter string) *ProjectsGetXpnResourcesCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
+// MaxResults sets the optional parameter "maxResults":
+func (c *ProjectsGetXpnResourcesCall) MaxResults(maxResults int64) *ProjectsGetXpnResourcesCall {
+ c.urlParams_.Set("maxResults", fmt.Sprint(maxResults))
+ return c
+}
+
+// OrderBy sets the optional parameter "order_by":
+func (c *ProjectsGetXpnResourcesCall) OrderBy(orderBy string) *ProjectsGetXpnResourcesCall {
+ c.urlParams_.Set("order_by", orderBy)
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken":
+func (c *ProjectsGetXpnResourcesCall) PageToken(pageToken string) *ProjectsGetXpnResourcesCall {
+ 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 *ProjectsGetXpnResourcesCall) Fields(s ...googleapi.Field) *ProjectsGetXpnResourcesCall {
+ 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 *ProjectsGetXpnResourcesCall) IfNoneMatch(entityTag string) *ProjectsGetXpnResourcesCall {
+ 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 *ProjectsGetXpnResourcesCall) Context(ctx context.Context) *ProjectsGetXpnResourcesCall {
+ 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 *ProjectsGetXpnResourcesCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsGetXpnResourcesCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/getXpnResources")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.projects.getXpnResources" call.
+// Exactly one of *ProjectsGetXpnResources or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ProjectsGetXpnResources.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 *ProjectsGetXpnResourcesCall) Do(opts ...googleapi.CallOption) (*ProjectsGetXpnResources, 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 := &ProjectsGetXpnResources{
+ 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 XPN resources associated with this host project.",
+ // "httpMethod": "GET",
+ // "id": "compute.projects.getXpnResources",
+ // "parameterOrder": [
+ // "project"
+ // ],
+ // "parameters": {
+ // "filter": {
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "maxResults": {
+ // "default": "500",
+ // "format": "uint32",
+ // "location": "query",
+ // "minimum": "0",
+ // "type": "integer"
+ // },
+ // "order_by": {
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "pageToken": {
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/getXpnResources",
+ // "response": {
+ // "$ref": "ProjectsGetXpnResources"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute",
+ // "https://www.googleapis.com/auth/compute.readonly"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsGetXpnResourcesCall) Pages(ctx context.Context, f func(*ProjectsGetXpnResources) 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 "compute.projects.listXpnHosts":
+
+type ProjectsListXpnHostsCall struct {
+ s *Service
+ project string
+ projectslistxpnhostsrequest *ProjectsListXpnHostsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// ListXpnHosts: List all XPN host projects visible to the user in an
+// organization.
+func (r *ProjectsService) ListXpnHosts(project string, projectslistxpnhostsrequest *ProjectsListXpnHostsRequest) *ProjectsListXpnHostsCall {
+ c := &ProjectsListXpnHostsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.projectslistxpnhostsrequest = projectslistxpnhostsrequest
+ return c
+}
+
+// Filter sets the optional parameter "filter":
+func (c *ProjectsListXpnHostsCall) Filter(filter string) *ProjectsListXpnHostsCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
+// MaxResults sets the optional parameter "maxResults":
+func (c *ProjectsListXpnHostsCall) MaxResults(maxResults int64) *ProjectsListXpnHostsCall {
+ c.urlParams_.Set("maxResults", fmt.Sprint(maxResults))
+ return c
+}
+
+// OrderBy sets the optional parameter "order_by":
+func (c *ProjectsListXpnHostsCall) OrderBy(orderBy string) *ProjectsListXpnHostsCall {
+ c.urlParams_.Set("order_by", orderBy)
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken":
+func (c *ProjectsListXpnHostsCall) PageToken(pageToken string) *ProjectsListXpnHostsCall {
+ 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 *ProjectsListXpnHostsCall) Fields(s ...googleapi.Field) *ProjectsListXpnHostsCall {
+ 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 *ProjectsListXpnHostsCall) Context(ctx context.Context) *ProjectsListXpnHostsCall {
+ 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 *ProjectsListXpnHostsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsListXpnHostsCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.projectslistxpnhostsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/listXpnHosts")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.projects.listXpnHosts" call.
+// Exactly one of *XpnHostList or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *XpnHostList.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 *ProjectsListXpnHostsCall) Do(opts ...googleapi.CallOption) (*XpnHostList, 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 := &XpnHostList{
+ 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": "List all XPN host projects visible to the user in an organization.",
+ // "httpMethod": "POST",
+ // "id": "compute.projects.listXpnHosts",
+ // "parameterOrder": [
+ // "project"
+ // ],
+ // "parameters": {
+ // "filter": {
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "maxResults": {
+ // "default": "500",
+ // "format": "uint32",
+ // "location": "query",
+ // "minimum": "0",
+ // "type": "integer"
+ // },
+ // "order_by": {
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "pageToken": {
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/listXpnHosts",
+ // "request": {
+ // "$ref": "ProjectsListXpnHostsRequest"
+ // },
+ // "response": {
+ // "$ref": "XpnHostList"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute",
+ // "https://www.googleapis.com/auth/compute.readonly"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsListXpnHostsCall) Pages(ctx context.Context, f func(*XpnHostList) 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 "compute.projects.moveDisk":
type ProjectsMoveDiskCall struct {
@@ -40869,6 +43026,11 @@
// been removed from the group. You must separately verify the status of
// the abandoning action with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *RegionInstanceGroupManagersService) AbandonInstances(project string, region string, instanceGroupManager string, regioninstancegroupmanagersabandoninstancesrequest *RegionInstanceGroupManagersAbandonInstancesRequest) *RegionInstanceGroupManagersAbandonInstancesCall {
@@ -40968,7 +43130,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.abandonInstances",
// "parameterOrder": [
@@ -41180,6 +43342,11 @@
// deleted. You must separately verify the status of the deleting action
// with the listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *RegionInstanceGroupManagersService) DeleteInstances(project string, region string, instanceGroupManager string, regioninstancegroupmanagersdeleteinstancesrequest *RegionInstanceGroupManagersDeleteInstancesRequest) *RegionInstanceGroupManagersDeleteInstancesCall {
@@ -41279,7 +43446,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.deleteInstances",
// "parameterOrder": [
@@ -42115,6 +44282,11 @@
// separately verify the status of the recreating action with the
// listmanagedinstances method.
//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or
+// deleted.
+//
// You can specify a maximum of 1000 instances with this method per
// request.
func (r *RegionInstanceGroupManagersService) RecreateInstances(project string, region string, instanceGroupManager string, regioninstancegroupmanagersrecreaterequest *RegionInstanceGroupManagersRecreateRequest) *RegionInstanceGroupManagersRecreateInstancesCall {
@@ -42214,7 +44386,7 @@
}
return ret, nil
// {
- // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nYou can specify a maximum of 1000 instances with this method per request.",
+ // "description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.recreateInstances",
// "parameterOrder": [
@@ -42278,6 +44450,10 @@
// scheduled even if the group has not yet added or deleted any
// instances. You must separately verify the status of the creating or
// deleting actions with the listmanagedinstances method.
+//
+// If the group is part of a backend service that has enabled connection
+// draining, it can take up to 60 seconds after the connection draining
+// duration has elapsed before the VM instance is removed or deleted.
func (r *RegionInstanceGroupManagersService) Resize(project string, region string, instanceGroupManager string, size int64) *RegionInstanceGroupManagersResizeCall {
c := &RegionInstanceGroupManagersResizeCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.project = project
@@ -42370,7 +44546,7 @@
}
return ret, nil
// {
- // "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.",
+ // "description": "Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
// "httpMethod": "POST",
// "id": "compute.regionInstanceGroupManagers.resize",
// "parameterOrder": [
@@ -47384,6 +49560,153 @@
}
}
+// method id "compute.snapshots.setLabels":
+
+type SnapshotsSetLabelsCall struct {
+ s *Service
+ project string
+ resource string
+ globalsetlabelsrequest *GlobalSetLabelsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetLabels: Sets the labels on a snapshot. To learn more about labels,
+// read the Labeling or Tagging Resources documentation.
+func (r *SnapshotsService) SetLabels(project string, resource string, globalsetlabelsrequest *GlobalSetLabelsRequest) *SnapshotsSetLabelsCall {
+ c := &SnapshotsSetLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.resource = resource
+ c.globalsetlabelsrequest = globalsetlabelsrequest
+ 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 *SnapshotsSetLabelsCall) Fields(s ...googleapi.Field) *SnapshotsSetLabelsCall {
+ 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 *SnapshotsSetLabelsCall) Context(ctx context.Context) *SnapshotsSetLabelsCall {
+ 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 *SnapshotsSetLabelsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *SnapshotsSetLabelsCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.globalsetlabelsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/snapshots/{resource}/setLabels")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.snapshots.setLabels" 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 *SnapshotsSetLabelsCall) 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": "Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.",
+ // "httpMethod": "POST",
+ // "id": "compute.snapshots.setLabels",
+ // "parameterOrder": [
+ // "project",
+ // "resource"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "resource": {
+ // "description": "Name of the resource for this request.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/global/snapshots/{resource}/setLabels",
+ // "request": {
+ // "$ref": "GlobalSetLabelsRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
// method id "compute.sslCertificates.delete":
type SslCertificatesDeleteCall struct {
@@ -55182,6 +57505,975 @@
}
+// method id "compute.targetTcpProxies.delete":
+
+type TargetTcpProxiesDeleteCall struct {
+ s *Service
+ project string
+ targetTcpProxy string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes the specified TargetTcpProxy resource.
+func (r *TargetTcpProxiesService) Delete(project string, targetTcpProxy string) *TargetTcpProxiesDeleteCall {
+ c := &TargetTcpProxiesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.targetTcpProxy = targetTcpProxy
+ 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 *TargetTcpProxiesDeleteCall) Fields(s ...googleapi.Field) *TargetTcpProxiesDeleteCall {
+ 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 *TargetTcpProxiesDeleteCall) Context(ctx context.Context) *TargetTcpProxiesDeleteCall {
+ 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 *TargetTcpProxiesDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *TargetTcpProxiesDeleteCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetTcpProxies/{targetTcpProxy}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ "targetTcpProxy": c.targetTcpProxy,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.targetTcpProxies.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 *TargetTcpProxiesDeleteCall) 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 the specified TargetTcpProxy resource.",
+ // "httpMethod": "DELETE",
+ // "id": "compute.targetTcpProxies.delete",
+ // "parameterOrder": [
+ // "project",
+ // "targetTcpProxy"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "targetTcpProxy": {
+ // "description": "Name of the TargetTcpProxy resource to delete.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/global/targetTcpProxies/{targetTcpProxy}",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
+// method id "compute.targetTcpProxies.get":
+
+type TargetTcpProxiesGetCall struct {
+ s *Service
+ project string
+ targetTcpProxy string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Returns the specified TargetTcpProxy resource. Get a list of
+// available target TCP proxies by making a list() request.
+func (r *TargetTcpProxiesService) Get(project string, targetTcpProxy string) *TargetTcpProxiesGetCall {
+ c := &TargetTcpProxiesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.targetTcpProxy = targetTcpProxy
+ 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 *TargetTcpProxiesGetCall) Fields(s ...googleapi.Field) *TargetTcpProxiesGetCall {
+ 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 *TargetTcpProxiesGetCall) IfNoneMatch(entityTag string) *TargetTcpProxiesGetCall {
+ 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 *TargetTcpProxiesGetCall) Context(ctx context.Context) *TargetTcpProxiesGetCall {
+ 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 *TargetTcpProxiesGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *TargetTcpProxiesGetCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetTcpProxies/{targetTcpProxy}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ "targetTcpProxy": c.targetTcpProxy,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.targetTcpProxies.get" call.
+// Exactly one of *TargetTcpProxy or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *TargetTcpProxy.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 *TargetTcpProxiesGetCall) Do(opts ...googleapi.CallOption) (*TargetTcpProxy, 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 := &TargetTcpProxy{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Returns the specified TargetTcpProxy resource. Get a list of available target TCP proxies by making a list() request.",
+ // "httpMethod": "GET",
+ // "id": "compute.targetTcpProxies.get",
+ // "parameterOrder": [
+ // "project",
+ // "targetTcpProxy"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "targetTcpProxy": {
+ // "description": "Name of the TargetTcpProxy resource to return.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/global/targetTcpProxies/{targetTcpProxy}",
+ // "response": {
+ // "$ref": "TargetTcpProxy"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute",
+ // "https://www.googleapis.com/auth/compute.readonly"
+ // ]
+ // }
+
+}
+
+// method id "compute.targetTcpProxies.insert":
+
+type TargetTcpProxiesInsertCall struct {
+ s *Service
+ project string
+ targettcpproxy *TargetTcpProxy
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Insert: Creates a TargetTcpProxy resource in the specified project
+// using the data included in the request.
+func (r *TargetTcpProxiesService) Insert(project string, targettcpproxy *TargetTcpProxy) *TargetTcpProxiesInsertCall {
+ c := &TargetTcpProxiesInsertCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.targettcpproxy = targettcpproxy
+ 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 *TargetTcpProxiesInsertCall) Fields(s ...googleapi.Field) *TargetTcpProxiesInsertCall {
+ 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 *TargetTcpProxiesInsertCall) Context(ctx context.Context) *TargetTcpProxiesInsertCall {
+ 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 *TargetTcpProxiesInsertCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *TargetTcpProxiesInsertCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.targettcpproxy)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetTcpProxies")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.targetTcpProxies.insert" 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 *TargetTcpProxiesInsertCall) 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 TargetTcpProxy resource in the specified project using the data included in the request.",
+ // "httpMethod": "POST",
+ // "id": "compute.targetTcpProxies.insert",
+ // "parameterOrder": [
+ // "project"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/global/targetTcpProxies",
+ // "request": {
+ // "$ref": "TargetTcpProxy"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
+// method id "compute.targetTcpProxies.list":
+
+type TargetTcpProxiesListCall struct {
+ s *Service
+ project string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Retrieves the list of TargetTcpProxy resources available to the
+// specified project.
+func (r *TargetTcpProxiesService) List(project string) *TargetTcpProxiesListCall {
+ c := &TargetTcpProxiesListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ return c
+}
+
+// Filter sets the optional parameter "filter": Sets a filter expression
+// for filtering listed resources, in the form filter={expression}. Your
+// {expression} must be in the format: field_name comparison_string
+// literal_string.
+//
+// The field_name is the name of the field you want to compare. Only
+// atomic field types are supported (string, number, boolean). The
+// comparison_string must be either eq (equals) or ne (not equals). The
+// literal_string is the string value to filter to. The literal value
+// must be valid for the type of field you are filtering by (string,
+// number, boolean). For string fields, the literal value is interpreted
+// as a regular expression using RE2 syntax. The literal value must
+// match the entire field.
+//
+// For example, to filter for instances that do not have a name of
+// example-instance, you would use filter=name ne example-instance.
+//
+// You can filter on nested fields. For example, you could filter on
+// instances that have set the scheduling.automaticRestart field to
+// true. Use filtering on nested fields to take advantage of labels to
+// organize and search for results based on label values.
+//
+// To filter on multiple expressions, provide each separate expression
+// within parentheses. For example, (scheduling.automaticRestart eq
+// true) (zone eq us-central1-f). Multiple expressions are treated as
+// AND expressions, meaning that resources must match all expressions to
+// pass the filters.
+func (c *TargetTcpProxiesListCall) Filter(filter string) *TargetTcpProxiesListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
+// MaxResults sets the optional parameter "maxResults": The maximum
+// number of results per page that should be returned. If the number of
+// available results is larger than maxResults, Compute Engine returns a
+// nextPageToken that can be used to get the next page of results in
+// subsequent list requests. Acceptable values are 0 to 500, inclusive.
+// (Default: 500)
+func (c *TargetTcpProxiesListCall) MaxResults(maxResults int64) *TargetTcpProxiesListCall {
+ c.urlParams_.Set("maxResults", fmt.Sprint(maxResults))
+ return c
+}
+
+// OrderBy sets the optional parameter "orderBy": Sorts list results by
+// a certain order. By default, results are returned in alphanumerical
+// order based on the resource name.
+//
+// You can also sort results in descending order based on the creation
+// timestamp using orderBy="creationTimestamp desc". This sorts results
+// based on the creationTimestamp field in reverse chronological order
+// (newest result first). Use this to sort resources like operations so
+// that the newest operation is returned first.
+//
+// Currently, only sorting by name or creationTimestamp desc is
+// supported.
+func (c *TargetTcpProxiesListCall) OrderBy(orderBy string) *TargetTcpProxiesListCall {
+ c.urlParams_.Set("orderBy", orderBy)
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": Specifies a page
+// token to use. Set pageToken to the nextPageToken returned by a
+// previous list request to get the next page of results.
+func (c *TargetTcpProxiesListCall) PageToken(pageToken string) *TargetTcpProxiesListCall {
+ 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 *TargetTcpProxiesListCall) Fields(s ...googleapi.Field) *TargetTcpProxiesListCall {
+ 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 *TargetTcpProxiesListCall) IfNoneMatch(entityTag string) *TargetTcpProxiesListCall {
+ 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 *TargetTcpProxiesListCall) Context(ctx context.Context) *TargetTcpProxiesListCall {
+ 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 *TargetTcpProxiesListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *TargetTcpProxiesListCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetTcpProxies")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.targetTcpProxies.list" call.
+// Exactly one of *TargetTcpProxyList or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *TargetTcpProxyList.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 *TargetTcpProxiesListCall) Do(opts ...googleapi.CallOption) (*TargetTcpProxyList, 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 := &TargetTcpProxyList{
+ 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": "Retrieves the list of TargetTcpProxy resources available to the specified project.",
+ // "httpMethod": "GET",
+ // "id": "compute.targetTcpProxies.list",
+ // "parameterOrder": [
+ // "project"
+ // ],
+ // "parameters": {
+ // "filter": {
+ // "description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nYou can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "maxResults": {
+ // "default": "500",
+ // "description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)",
+ // "format": "uint32",
+ // "location": "query",
+ // "minimum": "0",
+ // "type": "integer"
+ // },
+ // "orderBy": {
+ // "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using orderBy=\"creationTimestamp desc\". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "pageToken": {
+ // "description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/global/targetTcpProxies",
+ // "response": {
+ // "$ref": "TargetTcpProxyList"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute",
+ // "https://www.googleapis.com/auth/compute.readonly"
+ // ]
+ // }
+
+}
+
+// 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 *TargetTcpProxiesListCall) Pages(ctx context.Context, f func(*TargetTcpProxyList) 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 "compute.targetTcpProxies.setBackendService":
+
+type TargetTcpProxiesSetBackendServiceCall struct {
+ s *Service
+ project string
+ targetTcpProxy string
+ targettcpproxiessetbackendservicerequest *TargetTcpProxiesSetBackendServiceRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetBackendService: Changes the BackendService for TargetTcpProxy.
+func (r *TargetTcpProxiesService) SetBackendService(project string, targetTcpProxy string, targettcpproxiessetbackendservicerequest *TargetTcpProxiesSetBackendServiceRequest) *TargetTcpProxiesSetBackendServiceCall {
+ c := &TargetTcpProxiesSetBackendServiceCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.targetTcpProxy = targetTcpProxy
+ c.targettcpproxiessetbackendservicerequest = targettcpproxiessetbackendservicerequest
+ 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 *TargetTcpProxiesSetBackendServiceCall) Fields(s ...googleapi.Field) *TargetTcpProxiesSetBackendServiceCall {
+ 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 *TargetTcpProxiesSetBackendServiceCall) Context(ctx context.Context) *TargetTcpProxiesSetBackendServiceCall {
+ 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 *TargetTcpProxiesSetBackendServiceCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *TargetTcpProxiesSetBackendServiceCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.targettcpproxiessetbackendservicerequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ "targetTcpProxy": c.targetTcpProxy,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.targetTcpProxies.setBackendService" 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 *TargetTcpProxiesSetBackendServiceCall) 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": "Changes the BackendService for TargetTcpProxy.",
+ // "httpMethod": "POST",
+ // "id": "compute.targetTcpProxies.setBackendService",
+ // "parameterOrder": [
+ // "project",
+ // "targetTcpProxy"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "targetTcpProxy": {
+ // "description": "Name of the TargetTcpProxy resource whose BackendService resource is to be set.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService",
+ // "request": {
+ // "$ref": "TargetTcpProxiesSetBackendServiceRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
+// method id "compute.targetTcpProxies.setProxyHeader":
+
+type TargetTcpProxiesSetProxyHeaderCall struct {
+ s *Service
+ project string
+ targetTcpProxy string
+ targettcpproxiessetproxyheaderrequest *TargetTcpProxiesSetProxyHeaderRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetProxyHeader: Changes the ProxyHeaderType for TargetTcpProxy.
+func (r *TargetTcpProxiesService) SetProxyHeader(project string, targetTcpProxy string, targettcpproxiessetproxyheaderrequest *TargetTcpProxiesSetProxyHeaderRequest) *TargetTcpProxiesSetProxyHeaderCall {
+ c := &TargetTcpProxiesSetProxyHeaderCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.project = project
+ c.targetTcpProxy = targetTcpProxy
+ c.targettcpproxiessetproxyheaderrequest = targettcpproxiessetproxyheaderrequest
+ 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 *TargetTcpProxiesSetProxyHeaderCall) Fields(s ...googleapi.Field) *TargetTcpProxiesSetProxyHeaderCall {
+ 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 *TargetTcpProxiesSetProxyHeaderCall) Context(ctx context.Context) *TargetTcpProxiesSetProxyHeaderCall {
+ 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 *TargetTcpProxiesSetProxyHeaderCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *TargetTcpProxiesSetProxyHeaderCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.targettcpproxiessetproxyheaderrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "project": c.project,
+ "targetTcpProxy": c.targetTcpProxy,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "compute.targetTcpProxies.setProxyHeader" 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 *TargetTcpProxiesSetProxyHeaderCall) 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": "Changes the ProxyHeaderType for TargetTcpProxy.",
+ // "httpMethod": "POST",
+ // "id": "compute.targetTcpProxies.setProxyHeader",
+ // "parameterOrder": [
+ // "project",
+ // "targetTcpProxy"
+ // ],
+ // "parameters": {
+ // "project": {
+ // "description": "Project ID for this request.",
+ // "location": "path",
+ // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "targetTcpProxy": {
+ // "description": "Name of the TargetTcpProxy resource whose ProxyHeader is to be set.",
+ // "location": "path",
+ // "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader",
+ // "request": {
+ // "$ref": "TargetTcpProxiesSetProxyHeaderRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/compute"
+ // ]
+ // }
+
+}
+
// method id "compute.targetVpnGateways.aggregatedList":
type TargetVpnGatewaysAggregatedListCall struct {
diff --git a/container/v1/container-api.json b/container/v1/container-api.json
index 8a43716..f8c3cef 100644
--- a/container/v1/container-api.json
+++ b/container/v1/container-api.json
@@ -1,13 +1,10 @@
{
- "ownerName": "Google",
- "discoveryVersion": "v1",
"resources": {
"projects": {
"resources": {
"zones": {
"methods": {
"getServerconfig": {
- "httpMethod": "GET",
"parameterOrder": [
"projectId",
"zone"
@@ -15,387 +12,37 @@
"response": {
"$ref": "ServerConfig"
},
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "id": "container.projects.zones.getServerconfig",
"path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
+ "id": "container.projects.zones.getServerconfig",
"description": "Returns configuration info about the Container Engine service."
}
},
"resources": {
- "operations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations",
- "path": "v1/projects/{projectId}/zones/{zone}/operations",
- "id": "container.projects.zones.operations.list",
- "description": "Lists all operations in a project in a specific zone or all zones."
- },
- "get": {
- "id": "container.projects.zones.operations.get",
- "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "description": "Gets the specified operation.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}"
- },
- "cancel": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "id": "container.projects.zones.operations.cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Cancels the specified operation."
- }
- }
- },
"clusters": {
"methods": {
- "legacyAbac": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to update.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "id": "container.projects.zones.clusters.legacyAbac",
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "description": "Enables or disables the ABAC authorization mechanism on a cluster."
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to retrieve.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.get",
- "description": "Gets the details of a specific cluster.",
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "GET"
- },
- "update": {
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.update",
- "description": "Updates the settings of a specific cluster.",
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "startIpRotation": {
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
- "id": "container.projects.zones.clusters.startIpRotation",
- "description": "Start master IP rotation.",
- "request": {
- "$ref": "StartIPRotationRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation"
- },
- "setMasterAuth": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
- "id": "container.projects.zones.clusters.setMasterAuth",
- "request": {
- "$ref": "SetMasterAuthRequest"
- },
- "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set the password."
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to delete.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.delete",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time."
- },
"list": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.list",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters",
"description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
"httpMethod": "GET",
"response": {
@@ -405,16 +52,88 @@
"projectId",
"zone"
],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
"required": true,
"type": "string",
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ "location": "path"
},
"zone": {
+ "location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.",
"required": true,
+ "type": "string"
+ }
+ }
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.create",
+ "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
+ "request": {
+ "$ref": "CreateClusterRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "resourceLabels": {
+ "request": {
+ "$ref": "SetLabelsRequest"
+ },
+ "description": "Sets labels on a cluster.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.",
+ "required": true,
"type": "string",
"location": "path"
}
@@ -422,52 +141,99 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.list",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters"
- },
- "resourceLabels": {
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
"id": "container.projects.zones.clusters.resourceLabels",
- "description": "Sets labels on a cluster.",
- "request": {
- "$ref": "SetLabelsRequest"
- },
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels"
+ },
+ "completeIpRotation": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
"response": {
"$ref": "Operation"
},
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "id": "container.projects.zones.clusters.completeIpRotation",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "request": {
+ "$ref": "CompleteIPRotationRequest"
+ },
+ "description": "Completes master IP rotation."
+ },
+ "get": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.get",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "description": "Gets the details of a specific cluster.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Cluster"
+ },
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
"required": true,
"type": "string",
- "location": "path",
- "description": "The name of the cluster."
+ "location": "path"
},
- "projectId": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
"location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "description": "The name of the cluster to retrieve.",
"required": true,
"type": "string"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
- "create": {
+ "legacyAbac": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -483,25 +249,68 @@
"required": true,
"type": "string",
"location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.create",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters",
- "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ "id": "container.projects.zones.clusters.legacyAbac",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
"request": {
- "$ref": "CreateClusterRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "response": {
- "$ref": "Operation"
+ "$ref": "SetLegacyAbacRequest"
}
},
- "completeIpRotation": {
+ "update": {
+ "request": {
+ "$ref": "UpdateClusterRequest"
+ },
+ "description": "Updates the settings of a specific cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.update"
+ },
+ "startIpRotation": {
+ "request": {
+ "$ref": "StartIPRotationRequest"
+ },
+ "description": "Start master IP rotation.",
"response": {
"$ref": "Operation"
},
@@ -511,10 +320,13 @@
"clusterId"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string"
+ },
"zone": {
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"required": true,
@@ -522,25 +334,97 @@
"location": "path"
},
"clusterId": {
+ "location": "path",
"description": "The name of the cluster.",
"required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "id": "container.projects.zones.clusters.startIpRotation"
+ },
+ "setMasterAuth": {
+ "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set the password.",
+ "request": {
+ "$ref": "SetMasterAuthRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
+ "id": "container.projects.zones.clusters.setMasterAuth",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth"
+ },
+ "delete": {
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
"type": "string",
"location": "path"
},
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to delete.",
"required": true,
"type": "string",
"location": "path"
}
},
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "id": "container.projects.zones.clusters.completeIpRotation",
- "description": "Completes master IP rotation.",
- "request": {
- "$ref": "CompleteIPRotationRequest"
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.delete",
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time."
}
},
"resources": {
@@ -548,6 +432,9 @@
"methods": {
"delete": {
"description": "Deletes a node pool from a cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"projectId",
"zone",
@@ -555,13 +442,13 @@
"nodePoolId"
],
"httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string"
+ },
"zone": {
"location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
@@ -575,18 +462,15 @@
"location": "path"
},
"nodePoolId": {
- "location": "path",
"description": "The name of the node pool to delete.",
"required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
"id": "container.projects.zones.clusters.nodePools.delete"
@@ -602,7 +486,16 @@
"nodePoolId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
"zone": {
"location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
@@ -610,77 +503,65 @@
"type": "string"
},
"clusterId": {
+ "description": "The name of the cluster to update.",
"required": true,
"type": "string",
- "location": "path",
- "description": "The name of the cluster to update."
+ "location": "path"
},
"nodePoolId": {
+ "location": "path",
"description": "The name of the node pool to update.",
"required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
"id": "container.projects.zones.clusters.nodePools.setManagement",
+ "description": "Sets the NodeManagement options for a node pool.",
"request": {
"$ref": "SetNodePoolManagementRequest"
- },
- "description": "Sets the NodeManagement options for a node pool."
+ }
},
"list": {
- "id": "container.projects.zones.clusters.nodePools.list",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "description": "Lists the node pools for a cluster.",
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "response": {
- "$ref": "ListNodePoolsResponse"
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"projectId": {
+ "location": "path",
"description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
"required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
"type": "string",
"location": "path"
},
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
"clusterId": {
- "location": "path",
"description": "The name of the cluster.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools"
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.list",
+ "description": "Lists the node pools for a cluster."
},
"rollback": {
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "id": "container.projects.zones.clusters.nodePools.rollback",
"request": {
"$ref": "RollbackNodePoolUpgradeRequest"
},
@@ -696,40 +577,39 @@
],
"httpMethod": "POST",
"parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "nodePoolId": {
+ "description": "The name of the node pool to rollback.",
"required": true,
"type": "string",
"location": "path"
},
- "zone": {
+ "projectId": {
"location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
"required": true,
"type": "string"
},
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
"clusterId": {
"description": "The name of the cluster to rollback.",
"required": true,
"type": "string",
"location": "path"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to rollback.",
- "required": true,
- "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
+ "id": "container.projects.zones.clusters.nodePools.rollback"
},
"create": {
- "request": {
- "$ref": "CreateNodePoolRequest"
- },
- "description": "Creates a node pool for a cluster.",
"response": {
"$ref": "Operation"
},
@@ -741,16 +621,16 @@
"httpMethod": "POST",
"parameters": {
"projectId": {
- "location": "path",
"description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"zone": {
- "location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"clusterId": {
"description": "The name of the cluster.",
@@ -764,7 +644,11 @@
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "id": "container.projects.zones.clusters.nodePools.create"
+ "id": "container.projects.zones.clusters.nodePools.create",
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ },
+ "description": "Creates a node pool for a cluster."
},
"get": {
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
@@ -781,6 +665,9 @@
"nodePoolId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
"location": "path",
@@ -795,10 +682,10 @@
"type": "string"
},
"clusterId": {
+ "location": "path",
"description": "The name of the cluster.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"nodePoolId": {
"location": "path",
@@ -806,10 +693,121 @@
"required": true,
"type": "string"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "description": "Lists all operations in a project in a specific zone or all zones.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations",
+ "id": "container.projects.zones.operations.list"
+ },
+ "get": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "id": "container.projects.zones.operations.get",
+ "description": "Gets the specified operation.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "cancel": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "id": "container.projects.zones.operations.cancel",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "description": "Cancels the specified operation.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.",
+ "required": true,
+ "type": "string"
}
}
}
@@ -821,38 +819,6 @@
}
},
"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."
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "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\").",
@@ -863,25 +829,30 @@
"type": "string",
"location": "query"
},
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
+ "enumDescriptions": [
+ "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",
@@ -890,219 +861,52 @@
"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"
- ]
+ "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"
},
- "key": {
- "type": "string",
+ "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"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
}
},
"schemas": {
- "AutoUpgradeOptions": {
- "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.",
- "type": "object",
- "properties": {
- "autoUpgradeStartTime": {
- "description": "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
- "description": {
- "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
- "type": "string"
- }
- },
- "id": "AutoUpgradeOptions"
- },
- "ListClustersResponse": {
- "description": "ListClustersResponse is the result of ListClustersRequest.",
- "type": "object",
- "properties": {
- "missingZones": {
- "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "clusters": {
- "description": "A list of clusters in the project in the specified zone, or\nacross all ones.",
- "type": "array",
- "items": {
- "$ref": "Cluster"
- }
- }
- },
- "id": "ListClustersResponse"
- },
- "HttpLoadBalancing": {
- "description": "Configuration options for the HTTP (L7) load balancing controller addon,\nwhich makes it easy to set up HTTP load balancers for services in a cluster.",
- "type": "object",
- "properties": {
- "disabled": {
- "description": "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers.",
- "type": "boolean"
- }
- },
- "id": "HttpLoadBalancing"
- },
- "SetMasterAuthRequest": {
- "description": "SetMasterAuthRequest updates the admin password of a cluster.",
- "type": "object",
- "properties": {
- "update": {
- "$ref": "MasterAuth",
- "description": "A description of the update."
- },
- "action": {
- "enum": [
- "UNKNOWN",
- "SET_PASSWORD",
- "GENERATE_PASSWORD"
- ],
- "description": "The exact form of action to be taken on the master auth",
- "type": "string",
- "enumDescriptions": [
- "Operation is unknown and will error out",
- "Set the password to a user generated value.",
- "Generate a new password and set it to that."
- ]
- }
- },
- "id": "SetMasterAuthRequest"
- },
- "NodePoolAutoscaling": {
- "properties": {
- "maxNodeCount": {
- "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
- "format": "int32",
- "type": "integer"
- },
- "minNodeCount": {
- "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
- "format": "int32",
- "type": "integer"
- },
- "enabled": {
- "description": "Is autoscaling enabled for this node pool.",
- "type": "boolean"
- }
- },
- "id": "NodePoolAutoscaling",
- "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
- "type": "object"
- },
- "ClusterUpdate": {
- "properties": {
- "desiredMasterVersion": {
- "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.",
- "type": "string"
- },
- "desiredNodePoolAutoscaling": {
- "$ref": "NodePoolAutoscaling",
- "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool."
- },
- "desiredLocations": {
- "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "desiredMonitoringService": {
- "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
- "type": "string"
- },
- "desiredImageType": {
- "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
- "type": "string"
- },
- "desiredAddonsConfig": {
- "$ref": "AddonsConfig",
- "description": "Configurations for the various addons available to run in the cluster."
- },
- "desiredNodePoolId": {
- "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
- "type": "string"
- },
- "desiredNodeVersion": {
- "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
- "type": "string"
- }
- },
- "id": "ClusterUpdate",
- "description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.",
- "type": "object"
- },
- "HorizontalPodAutoscaling": {
- "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
- "type": "object",
- "properties": {
- "disabled": {
- "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that a Heapster pod is running in the cluster,\nwhich is also used by the Cloud Monitoring service.",
- "type": "boolean"
- }
- },
- "id": "HorizontalPodAutoscaling"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "SetNodePoolManagementRequest": {
- "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
- "type": "object",
- "properties": {
- "management": {
- "$ref": "NodeManagement",
- "description": "NodeManagement configuration for the node pool."
- }
- },
- "id": "SetNodePoolManagementRequest"
- },
- "CreateClusterRequest": {
- "id": "CreateClusterRequest",
- "description": "CreateClusterRequest creates a cluster.",
- "type": "object",
- "properties": {
- "cluster": {
- "$ref": "Cluster",
- "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)"
- }
- }
- },
- "ListNodePoolsResponse": {
- "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
- "type": "object",
- "properties": {
- "nodePools": {
- "description": "A list of node pools for a cluster.",
- "type": "array",
- "items": {
- "$ref": "NodePool"
- }
- }
- },
- "id": "ListNodePoolsResponse"
- },
- "CompleteIPRotationRequest": {
- "id": "CompleteIPRotationRequest",
- "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
- "type": "object",
- "properties": {}
- },
"StartIPRotationRequest": {
"description": "StartIPRotationRequest creates a new IP for the cluster and then performs\na node upgrade on each node pool to point to the new IP.",
"type": "object",
@@ -1125,20 +929,22 @@
"type": "object",
"properties": {
"labelFingerprint": {
- "type": "string",
- "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint."
+ "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
+ "type": "string"
},
"resourceLabels": {
+ "description": "The labels to set for that cluster.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "The labels to set for that cluster.",
- "type": "object"
+ }
}
},
"id": "SetLabelsRequest"
},
"NodePool": {
+ "description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.",
+ "type": "object",
"properties": {
"status": {
"enumDescriptions": [
@@ -1163,30 +969,30 @@
"type": "string"
},
"config": {
- "$ref": "NodeConfig",
- "description": "The node configuration of the pool."
- },
- "statusMessage": {
- "description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.",
- "type": "string"
+ "description": "The node configuration of the pool.",
+ "$ref": "NodeConfig"
},
"name": {
"description": "The name of the node pool.",
"type": "string"
},
+ "statusMessage": {
+ "description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.",
+ "type": "string"
+ },
"autoscaling": {
"$ref": "NodePoolAutoscaling",
"description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present."
},
- "management": {
- "$ref": "NodeManagement",
- "description": "NodeManagement configuration for this NodePool."
- },
"initialNodeCount": {
"description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.",
"format": "int32",
"type": "integer"
},
+ "management": {
+ "$ref": "NodeManagement",
+ "description": "NodeManagement configuration for this NodePool."
+ },
"selfLink": {
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
@@ -1203,9 +1009,7 @@
"type": "string"
}
},
- "id": "NodePool",
- "description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.",
- "type": "object"
+ "id": "NodePool"
},
"NodeManagement": {
"description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
@@ -1227,10 +1031,10 @@
"id": "NodeManagement"
},
"CancelOperationRequest": {
+ "description": "CancelOperationRequest cancels a single operation.",
"type": "object",
"properties": {},
- "id": "CancelOperationRequest",
- "description": "CancelOperationRequest cancels a single operation."
+ "id": "CancelOperationRequest"
},
"SetLegacyAbacRequest": {
"description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
@@ -1247,10 +1051,6 @@
"description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.",
"type": "object",
"properties": {
- "zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place."
- },
"status": {
"description": "The current status of the operation.",
"type": "string",
@@ -1282,15 +1082,14 @@
"type": "string"
},
"targetLink": {
- "type": "string",
- "description": "Server-defined URL for the target of the operation."
+ "description": "Server-defined URL for the target of the operation.",
+ "type": "string"
},
"detail": {
"description": "Detailed operation progress, if available.",
"type": "string"
},
"operationType": {
- "type": "string",
"enumDescriptions": [
"Not set.",
"Cluster create.",
@@ -1323,7 +1122,12 @@
"SET_LABELS",
"SET_MASTER_AUTH"
],
- "description": "The operation type."
+ "description": "The operation type.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.",
+ "type": "string"
}
},
"id": "Operation"
@@ -1337,8 +1141,8 @@
"description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods."
},
"httpLoadBalancing": {
- "$ref": "HttpLoadBalancing",
- "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster."
+ "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster.",
+ "$ref": "HttpLoadBalancing"
}
},
"id": "AddonsConfig"
@@ -1354,8 +1158,8 @@
"type": "object",
"properties": {
"update": {
- "description": "A description of the update.",
- "$ref": "ClusterUpdate"
+ "$ref": "ClusterUpdate",
+ "description": "A description of the update."
}
},
"id": "UpdateClusterRequest"
@@ -1364,9 +1168,60 @@
"description": "A Google Container Engine cluster.",
"type": "object",
"properties": {
+ "nodeConfig": {
+ "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used.",
+ "$ref": "NodeConfig"
+ },
+ "addonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "Configurations for the various addons available to run in the cluster."
+ },
+ "status": {
+ "description": "[Output only] The current status of this cluster.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not set.",
+ "The PROVISIONING state indicates the cluster is being created.",
+ "The RUNNING state indicates the cluster has been created and is fully\nusable.",
+ "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.",
+ "The STOPPING state indicates the cluster is being deleted.",
+ "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PROVISIONING",
+ "RUNNING",
+ "RECONCILING",
+ "STOPPING",
+ "ERROR"
+ ]
+ },
+ "subnetwork": {
+ "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.",
+ "type": "string"
+ },
+ "currentNodeVersion": {
+ "description": "[Output only] The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
+ "type": "string"
+ },
+ "resourceLabels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The resource labels for the cluster to use to annotate any related GCE\nresources.",
+ "type": "object"
+ },
+ "initialClusterVersion": {
+ "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
+ "type": "string"
+ },
"legacyAbac": {
- "$ref": "LegacyAbac",
- "description": "Configuration for the legacy ABAC authorization mode."
+ "description": "Configuration for the legacy ABAC authorization mode.",
+ "$ref": "LegacyAbac"
},
"endpoint": {
"description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.",
@@ -1385,13 +1240,6 @@
"format": "int32",
"type": "integer"
},
- "nodePools": {
- "type": "array",
- "items": {
- "$ref": "NodePool"
- },
- "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified."
- },
"locations": {
"description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.",
"type": "array",
@@ -1403,6 +1251,13 @@
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
},
+ "nodePools": {
+ "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.",
+ "type": "array",
+ "items": {
+ "$ref": "NodePool"
+ }
+ },
"instanceGroupUrls": {
"description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\ncluster.",
"type": "array",
@@ -1443,10 +1298,6 @@
"description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string"
},
- "loggingService": {
- "description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.",
- "type": "string"
- },
"expireTime": {
"description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
@@ -1456,83 +1307,25 @@
"format": "int32",
"type": "integer"
},
+ "loggingService": {
+ "description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.",
+ "type": "string"
+ },
"statusMessage": {
"description": "[Output only] Additional information about the current status of this\ncluster, if available.",
"type": "string"
},
"masterAuth": {
- "$ref": "MasterAuth",
- "description": "The authentication information for accessing the master endpoint."
+ "description": "The authentication information for accessing the master endpoint.",
+ "$ref": "MasterAuth"
},
"currentMasterVersion": {
- "type": "string",
- "description": "[Output only] The current software version of the master endpoint."
- },
- "nodeConfig": {
- "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used.",
- "$ref": "NodeConfig"
- },
- "addonsConfig": {
- "$ref": "AddonsConfig",
- "description": "Configurations for the various addons available to run in the cluster."
- },
- "status": {
- "description": "[Output only] The current status of this cluster.",
- "type": "string",
- "enumDescriptions": [
- "Not set.",
- "The PROVISIONING state indicates the cluster is being created.",
- "The RUNNING state indicates the cluster has been created and is fully\nusable.",
- "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.",
- "The STOPPING state indicates the cluster is being deleted.",
- "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "PROVISIONING",
- "RUNNING",
- "RECONCILING",
- "STOPPING",
- "ERROR"
- ]
- },
- "currentNodeVersion": {
- "description": "[Output only] The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.",
+ "description": "[Output only] The current software version of the master endpoint.",
"type": "string"
- },
- "subnetwork": {
- "type": "string",
- "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected."
- },
- "resourceLabels": {
- "description": "The resource labels for the cluster to use to annotate any related GCE\nresources.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "name": {
- "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
- "type": "string"
- },
- "initialClusterVersion": {
- "type": "string",
- "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion."
}
},
"id": "Cluster"
},
- "CreateNodePoolRequest": {
- "description": "CreateNodePoolRequest creates a node pool for a cluster.",
- "type": "object",
- "properties": {
- "nodePool": {
- "description": "The node pool to create.",
- "$ref": "NodePool"
- }
- },
- "id": "CreateNodePoolRequest"
- },
"ListOperationsResponse": {
"description": "ListOperationsResponse is the result of ListOperationsRequest.",
"type": "object",
@@ -1554,24 +1347,21 @@
},
"id": "ListOperationsResponse"
},
+ "CreateNodePoolRequest": {
+ "description": "CreateNodePoolRequest creates a node pool for a cluster.",
+ "type": "object",
+ "properties": {
+ "nodePool": {
+ "$ref": "NodePool",
+ "description": "The node pool to create."
+ }
+ },
+ "id": "CreateNodePoolRequest"
+ },
"ServerConfig": {
"description": "Container Engine service configuration.",
"type": "object",
"properties": {
- "validNodeVersions": {
- "description": "List of valid node upgrade target versions.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "validImageTypes": {
- "description": "List of valid image types.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"validMasterVersions": {
"description": "List of valid master versions.",
"type": "array",
@@ -1586,6 +1376,20 @@
"defaultImageType": {
"description": "Default image type.",
"type": "string"
+ },
+ "validNodeVersions": {
+ "description": "List of valid node upgrade target versions.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "validImageTypes": {
+ "description": "List of valid image types.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "ServerConfig"
@@ -1595,11 +1399,11 @@
"type": "object",
"properties": {
"metadata": {
+ "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
- "type": "object"
+ }
},
"diskSizeGb": {
"description": "Size of the disk attached to each node, specified in GB.\nThe smallest allowed disk size is 10GB.\n\nIf unspecified, the default disk size is 100GB.",
@@ -1637,16 +1441,16 @@
"type": "boolean"
},
"labels": {
+ "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttp://kubernetes.io/v1.1/docs/user-guide/labels.html",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttp://kubernetes.io/v1.1/docs/user-guide/labels.html",
- "type": "object"
+ }
},
"localSsdCount": {
- "type": "integer",
"description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
},
"id": "NodeConfig"
@@ -1655,6 +1459,10 @@
"description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.",
"type": "object",
"properties": {
+ "clientKey": {
+ "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
+ "type": "string"
+ },
"clusterCaCertificate": {
"description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.",
"type": "string"
@@ -1670,13 +1478,203 @@
"username": {
"description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, you can disable basic authentication by\nproviding an empty username.",
"type": "string"
- },
- "clientKey": {
- "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
- "type": "string"
}
},
"id": "MasterAuth"
+ },
+ "AutoUpgradeOptions": {
+ "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
+ "type": "string"
+ },
+ "autoUpgradeStartTime": {
+ "description": "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ }
+ },
+ "id": "AutoUpgradeOptions"
+ },
+ "ListClustersResponse": {
+ "description": "ListClustersResponse is the result of ListClustersRequest.",
+ "type": "object",
+ "properties": {
+ "missingZones": {
+ "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "clusters": {
+ "description": "A list of clusters in the project in the specified zone, or\nacross all ones.",
+ "type": "array",
+ "items": {
+ "$ref": "Cluster"
+ }
+ }
+ },
+ "id": "ListClustersResponse"
+ },
+ "HttpLoadBalancing": {
+ "description": "Configuration options for the HTTP (L7) load balancing controller addon,\nwhich makes it easy to set up HTTP load balancers for services in a cluster.",
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "description": "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers.",
+ "type": "boolean"
+ }
+ },
+ "id": "HttpLoadBalancing"
+ },
+ "NodePoolAutoscaling": {
+ "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Is autoscaling enabled for this node pool.",
+ "type": "boolean"
+ },
+ "maxNodeCount": {
+ "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minNodeCount": {
+ "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "NodePoolAutoscaling"
+ },
+ "SetMasterAuthRequest": {
+ "description": "SetMasterAuthRequest updates the admin password of a cluster.",
+ "type": "object",
+ "properties": {
+ "update": {
+ "description": "A description of the update.",
+ "$ref": "MasterAuth"
+ },
+ "action": {
+ "description": "The exact form of action to be taken on the master auth",
+ "type": "string",
+ "enumDescriptions": [
+ "Operation is unknown and will error out",
+ "Set the password to a user generated value.",
+ "Generate a new password and set it to that."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "SET_PASSWORD",
+ "GENERATE_PASSWORD"
+ ]
+ }
+ },
+ "id": "SetMasterAuthRequest"
+ },
+ "ClusterUpdate": {
+ "description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.",
+ "type": "object",
+ "properties": {
+ "desiredNodePoolId": {
+ "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
+ "type": "string"
+ },
+ "desiredNodeVersion": {
+ "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
+ "type": "string"
+ },
+ "desiredMasterVersion": {
+ "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.",
+ "type": "string"
+ },
+ "desiredLocations": {
+ "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "desiredNodePoolAutoscaling": {
+ "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool.",
+ "$ref": "NodePoolAutoscaling"
+ },
+ "desiredMonitoringService": {
+ "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
+ "type": "string"
+ },
+ "desiredImageType": {
+ "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
+ "type": "string"
+ },
+ "desiredAddonsConfig": {
+ "description": "Configurations for the various addons available to run in the cluster.",
+ "$ref": "AddonsConfig"
+ }
+ },
+ "id": "ClusterUpdate"
+ },
+ "HorizontalPodAutoscaling": {
+ "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that a Heapster pod is running in the cluster,\nwhich is also used by the Cloud Monitoring service.",
+ "type": "boolean"
+ }
+ },
+ "id": "HorizontalPodAutoscaling"
+ },
+ "SetNodePoolManagementRequest": {
+ "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
+ "type": "object",
+ "properties": {
+ "management": {
+ "$ref": "NodeManagement",
+ "description": "NodeManagement configuration for the node pool."
+ }
+ },
+ "id": "SetNodePoolManagementRequest"
+ },
+ "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"
+ },
+ "CreateClusterRequest": {
+ "description": "CreateClusterRequest creates a cluster.",
+ "type": "object",
+ "properties": {
+ "cluster": {
+ "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)",
+ "$ref": "Cluster"
+ }
+ },
+ "id": "CreateClusterRequest"
+ },
+ "ListNodePoolsResponse": {
+ "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
+ "type": "object",
+ "properties": {
+ "nodePools": {
+ "description": "A list of node pools for a cluster.",
+ "type": "array",
+ "items": {
+ "$ref": "NodePool"
+ }
+ }
+ },
+ "id": "ListNodePoolsResponse"
+ },
+ "CompleteIPRotationRequest": {
+ "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
+ "type": "object",
+ "properties": {},
+ "id": "CompleteIPRotationRequest"
}
},
"icons": {
@@ -1696,15 +1694,17 @@
}
},
"servicePath": "",
- "kind": "discovery#restDescription",
"description": "The Google Container Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.",
+ "kind": "discovery#restDescription",
"rootUrl": "https://container.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "container",
"batchPath": "batch",
- "id": "container:v1",
"documentationLink": "https://cloud.google.com/container-engine/",
+ "id": "container:v1",
"revision": "20170430",
- "title": "Google Container Engine API"
+ "title": "Google Container Engine API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1"
}
diff --git a/content/v2/content-api.json b/content/v2/content-api.json
index f6e162a..16f84b0 100644
--- a/content/v2/content-api.json
+++ b/content/v2/content-api.json
@@ -1,12 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/tkmMskVFTW_4jdAKLGSBFnYS5lM\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/KezEFlb0qLWSiWSEDVdji56y1dU\"",
"discoveryVersion": "v1",
"id": "content:v2",
"name": "content",
"canonicalName": "Shopping Content",
"version": "v2",
- "revision": "20170406",
+ "revision": "20170523",
"title": "Content API for Shopping",
"description": "Manages product items, inventory, and Merchant Center accounts for Google Shopping.",
"ownerDomain": "google.com",
@@ -190,6 +190,10 @@
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountStatus\".",
"default": "content#accountStatus"
+ },
+ "websiteClaimed": {
+ "type": "boolean",
+ "description": "Whether the account's website is claimed or not."
}
}
},
@@ -364,6 +368,17 @@
}
}
},
+ "AccountsClaimWebsiteResponse": {
+ "id": "AccountsClaimWebsiteResponse",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsClaimWebsiteResponse\".",
+ "default": "content#accountsClaimWebsiteResponse"
+ }
+ }
+ },
"AccountsCustomBatchRequest": {
"id": "AccountsCustomBatchRequest",
"type": "object",
@@ -388,7 +403,7 @@
},
"accountId": {
"type": "string",
- "description": "The ID of the account to get or delete. Only defined if the method is get or delete.",
+ "description": "The ID of the targeted account. Only defined if the method is get, delete or claimwebsite.",
"format": "uint64"
},
"batchId": {
@@ -403,6 +418,10 @@
},
"method": {
"type": "string"
+ },
+ "overwrite": {
+ "type": "boolean",
+ "description": "Only applicable if the method is claimwebsite. Indicates whether or not to take the claim from another account in case there is a conflict."
}
}
},
@@ -431,7 +450,7 @@
"properties": {
"account": {
"$ref": "Account",
- "description": "The retrieved, created, or updated account. Not defined if the method was delete."
+ "description": "The retrieved, created, or updated account. Not defined if the method was delete or claimwebsite."
},
"batchId": {
"type": "integer",
@@ -4330,6 +4349,43 @@
"https://www.googleapis.com/auth/content"
]
},
+ "claimwebsite": {
+ "id": "content.accounts.claimwebsite",
+ "path": "{merchantId}/accounts/{accountId}/claimwebsite",
+ "httpMethod": "POST",
+ "description": "Claims the website of a Merchant Center sub-account. This method can only be called for multi-client accounts.",
+ "parameters": {
+ "accountId": {
+ "type": "string",
+ "description": "The ID of the account whose website is claimed.",
+ "required": true,
+ "format": "uint64",
+ "location": "path"
+ },
+ "merchantId": {
+ "type": "string",
+ "description": "The ID of the managing account.",
+ "required": true,
+ "format": "uint64",
+ "location": "path"
+ },
+ "overwrite": {
+ "type": "boolean",
+ "description": "Flag to remove any existing claim on the requested website by another account and replace it with a claim from this account.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "response": {
+ "$ref": "AccountsClaimWebsiteResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
"custombatch": {
"id": "content.accounts.custombatch",
"path": "accounts/batch",
@@ -5927,6 +5983,13 @@
"path": "productstatuses/batch",
"httpMethod": "POST",
"description": "Gets the statuses of multiple products in a single request. This method can only be called for non-multi-client accounts.",
+ "parameters": {
+ "includeAttributes": {
+ "type": "boolean",
+ "description": "Flag to include full product data in the results of this request. The default value is false.",
+ "location": "query"
+ }
+ },
"request": {
"$ref": "ProductstatusesCustomBatchRequest"
},
@@ -5943,6 +6006,11 @@
"httpMethod": "GET",
"description": "Gets the status of a product from your Merchant Center account. This method can only be called for non-multi-client accounts.",
"parameters": {
+ "includeAttributes": {
+ "type": "boolean",
+ "description": "Flag to include full product data in the result of this get request. The default value is false.",
+ "location": "query"
+ },
"merchantId": {
"type": "string",
"description": "The ID of the managing account.",
@@ -5974,6 +6042,11 @@
"httpMethod": "GET",
"description": "Lists the statuses of the products in your Merchant Center account. This method can only be called for non-multi-client accounts.",
"parameters": {
+ "includeAttributes": {
+ "type": "boolean",
+ "description": "Flag to include full product data in the results of the list request. The default value is false.",
+ "location": "query"
+ },
"includeInvalidInsertedItems": {
"type": "boolean",
"description": "Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).",
diff --git a/content/v2/content-gen.go b/content/v2/content-gen.go
index 0b4bbb9..64727ec 100644
--- a/content/v2/content-gen.go
+++ b/content/v2/content-gen.go
@@ -342,6 +342,9 @@
// string "content#accountStatus".
Kind string `json:"kind,omitempty"`
+ // WebsiteClaimed: Whether the account's website is claimed or not.
+ WebsiteClaimed bool `json:"websiteClaimed,omitempty"`
+
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
@@ -623,6 +626,38 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type AccountsClaimWebsiteResponse struct {
+ // Kind: Identifies what kind of resource this is. Value: the fixed
+ // string "content#accountsClaimWebsiteResponse".
+ Kind string `json:"kind,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Kind") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Kind") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *AccountsClaimWebsiteResponse) MarshalJSON() ([]byte, error) {
+ type noMethod AccountsClaimWebsiteResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type AccountsCustomBatchRequest struct {
// Entries: The request entries to be processed in the batch.
Entries []*AccountsCustomBatchRequestEntry `json:"entries,omitempty"`
@@ -657,8 +692,8 @@
// is insert or update.
Account *Account `json:"account,omitempty"`
- // AccountId: The ID of the account to get or delete. Only defined if
- // the method is get or delete.
+ // AccountId: The ID of the targeted account. Only defined if the method
+ // is get, delete or claimwebsite.
AccountId uint64 `json:"accountId,omitempty,string"`
// BatchId: An entry ID, unique within the batch request.
@@ -669,6 +704,11 @@
Method string `json:"method,omitempty"`
+ // Overwrite: Only applicable if the method is claimwebsite. Indicates
+ // whether or not to take the claim from another account in case there
+ // is a conflict.
+ Overwrite bool `json:"overwrite,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "Account") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -731,7 +771,7 @@
// non-batch accounts response.
type AccountsCustomBatchResponseEntry struct {
// Account: The retrieved, created, or updated account. Not defined if
- // the method was delete.
+ // the method was delete or claimwebsite.
Account *Account `json:"account,omitempty"`
// BatchId: The ID of the request entry this entry responds to.
@@ -6697,6 +6737,155 @@
}
+// method id "content.accounts.claimwebsite":
+
+type AccountsClaimwebsiteCall struct {
+ s *APIService
+ merchantId uint64
+ accountId uint64
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Claimwebsite: Claims the website of a Merchant Center sub-account.
+// This method can only be called for multi-client accounts.
+func (r *AccountsService) Claimwebsite(merchantId uint64, accountId uint64) *AccountsClaimwebsiteCall {
+ c := &AccountsClaimwebsiteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.merchantId = merchantId
+ c.accountId = accountId
+ return c
+}
+
+// Overwrite sets the optional parameter "overwrite": Flag to remove any
+// existing claim on the requested website by another account and
+// replace it with a claim from this account.
+func (c *AccountsClaimwebsiteCall) Overwrite(overwrite bool) *AccountsClaimwebsiteCall {
+ c.urlParams_.Set("overwrite", fmt.Sprint(overwrite))
+ 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 *AccountsClaimwebsiteCall) Fields(s ...googleapi.Field) *AccountsClaimwebsiteCall {
+ 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 *AccountsClaimwebsiteCall) Context(ctx context.Context) *AccountsClaimwebsiteCall {
+ 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 *AccountsClaimwebsiteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *AccountsClaimwebsiteCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "{merchantId}/accounts/{accountId}/claimwebsite")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "merchantId": strconv.FormatUint(c.merchantId, 10),
+ "accountId": strconv.FormatUint(c.accountId, 10),
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "content.accounts.claimwebsite" call.
+// Exactly one of *AccountsClaimWebsiteResponse or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *AccountsClaimWebsiteResponse.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 *AccountsClaimwebsiteCall) Do(opts ...googleapi.CallOption) (*AccountsClaimWebsiteResponse, 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 := &AccountsClaimWebsiteResponse{
+ 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": "Claims the website of a Merchant Center sub-account. This method can only be called for multi-client accounts.",
+ // "httpMethod": "POST",
+ // "id": "content.accounts.claimwebsite",
+ // "parameterOrder": [
+ // "merchantId",
+ // "accountId"
+ // ],
+ // "parameters": {
+ // "accountId": {
+ // "description": "The ID of the account whose website is claimed.",
+ // "format": "uint64",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "merchantId": {
+ // "description": "The ID of the managing account.",
+ // "format": "uint64",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "overwrite": {
+ // "description": "Flag to remove any existing claim on the requested website by another account and replace it with a claim from this account.",
+ // "location": "query",
+ // "type": "boolean"
+ // }
+ // },
+ // "path": "{merchantId}/accounts/{accountId}/claimwebsite",
+ // "response": {
+ // "$ref": "AccountsClaimWebsiteResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/content"
+ // ]
+ // }
+
+}
+
// method id "content.accounts.custombatch":
type AccountsCustombatchCall struct {
@@ -13890,6 +14079,14 @@
return c
}
+// IncludeAttributes sets the optional parameter "includeAttributes":
+// Flag to include full product data in the results of this request. The
+// default value is false.
+func (c *ProductstatusesCustombatchCall) IncludeAttributes(includeAttributes bool) *ProductstatusesCustombatchCall {
+ c.urlParams_.Set("includeAttributes", fmt.Sprint(includeAttributes))
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -13977,6 +14174,13 @@
// "description": "Gets the statuses of multiple products in a single request. This method can only be called for non-multi-client accounts.",
// "httpMethod": "POST",
// "id": "content.productstatuses.custombatch",
+ // "parameters": {
+ // "includeAttributes": {
+ // "description": "Flag to include full product data in the results of this request. The default value is false.",
+ // "location": "query",
+ // "type": "boolean"
+ // }
+ // },
// "path": "productstatuses/batch",
// "request": {
// "$ref": "ProductstatusesCustomBatchRequest"
@@ -14012,6 +14216,14 @@
return c
}
+// IncludeAttributes sets the optional parameter "includeAttributes":
+// Flag to include full product data in the result of this get request.
+// The default value is false.
+func (c *ProductstatusesGetCall) IncludeAttributes(includeAttributes bool) *ProductstatusesGetCall {
+ c.urlParams_.Set("includeAttributes", fmt.Sprint(includeAttributes))
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -14115,6 +14327,11 @@
// "productId"
// ],
// "parameters": {
+ // "includeAttributes": {
+ // "description": "Flag to include full product data in the result of this get request. The default value is false.",
+ // "location": "query",
+ // "type": "boolean"
+ // },
// "merchantId": {
// "description": "The ID of the managing account.",
// "format": "uint64",
@@ -14160,6 +14377,14 @@
return c
}
+// IncludeAttributes sets the optional parameter "includeAttributes":
+// Flag to include full product data in the results of the list request.
+// The default value is false.
+func (c *ProductstatusesListCall) IncludeAttributes(includeAttributes bool) *ProductstatusesListCall {
+ c.urlParams_.Set("includeAttributes", fmt.Sprint(includeAttributes))
+ return c
+}
+
// IncludeInvalidInsertedItems sets the optional parameter
// "includeInvalidInsertedItems": Flag to include the invalid inserted
// items in the result of the list request. By default the invalid items
@@ -14285,6 +14510,11 @@
// "merchantId"
// ],
// "parameters": {
+ // "includeAttributes": {
+ // "description": "Flag to include full product data in the results of the list request. The default value is false.",
+ // "location": "query",
+ // "type": "boolean"
+ // },
// "includeInvalidInsertedItems": {
// "description": "Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).",
// "location": "query",
diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json
index 6efdb47..87d0b25 100644
--- a/dataflow/v1b3/dataflow-api.json
+++ b/dataflow/v1b3/dataflow-api.json
@@ -1,8 +1,12 @@
{
+ "rootUrl": "https://dataflow.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "dataflow",
"batchPath": "batch",
"id": "dataflow:v1b3",
"documentationLink": "https://cloud.google.com/dataflow",
- "revision": "20170426",
+ "revision": "20170525",
"title": "Google Dataflow API",
"discoveryVersion": "v1",
"ownerName": "Google",
@@ -10,13 +14,13 @@
"projects": {
"methods": {
"workerMessages": {
- "response": {
- "$ref": "SendWorkerMessagesResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "SendWorkerMessagesResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -31,8 +35,8 @@
}
},
"flatPath": "v1b3/projects/{projectId}/WorkerMessages",
- "path": "v1b3/projects/{projectId}/WorkerMessages",
"id": "dataflow.projects.workerMessages",
+ "path": "v1b3/projects/{projectId}/WorkerMessages",
"description": "Send a worker_message to the service.",
"request": {
"$ref": "SendWorkerMessagesRequest"
@@ -42,11 +46,36 @@
"resources": {
"templates": {
"methods": {
- "launch": {
+ "create": {
+ "flatPath": "v1b3/projects/{projectId}/templates",
+ "path": "v1b3/projects/{projectId}/templates",
+ "id": "dataflow.projects.templates.create",
+ "description": "Creates a Cloud Dataflow job from a template.",
"request": {
- "$ref": "LaunchTemplateParameters"
+ "$ref": "CreateJobFromTemplateRequest"
},
- "description": "Launch a template.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "launch": {
"response": {
"$ref": "LaunchTemplateResponse"
},
@@ -56,9 +85,9 @@
"httpMethod": "POST",
"parameters": {
"validateOnly": {
- "location": "query",
"description": "If true, the request is validated but not actually executed.\nDefaults to false.",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"projectId": {
"location": "path",
@@ -67,9 +96,9 @@
"type": "string"
},
"gcsPath": {
- "location": "query",
"description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"location": {
"location": "query",
@@ -84,33 +113,41 @@
],
"flatPath": "v1b3/projects/{projectId}/templates:launch",
"path": "v1b3/projects/{projectId}/templates:launch",
- "id": "dataflow.projects.templates.launch"
+ "id": "dataflow.projects.templates.launch",
+ "request": {
+ "$ref": "LaunchTemplateParameters"
+ },
+ "description": "Launch a template."
},
"get": {
- "description": "Get the template associated with a template.",
"response": {
"$ref": "GetTemplateResponse"
},
+ "httpMethod": "GET",
"parameterOrder": [
"projectId"
],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
- "location": {
+ "gcsPath": {
"location": "query",
- "description": "The location to which to direct the request.",
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
"type": "string"
},
+ "location": {
+ "description": "The location to which to direct the request.",
+ "type": "string",
+ "location": "query"
+ },
"projectId": {
+ "location": "path",
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"view": {
"location": "query",
@@ -119,45 +156,12 @@
],
"description": "The view to retrieve. Defaults to METADATA_ONLY.",
"type": "string"
- },
- "gcsPath": {
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
- "type": "string",
- "location": "query"
}
},
"flatPath": "v1b3/projects/{projectId}/templates:get",
"path": "v1b3/projects/{projectId}/templates:get",
- "id": "dataflow.projects.templates.get"
- },
- "create": {
- "request": {
- "$ref": "CreateJobFromTemplateRequest"
- },
- "description": "Creates a Cloud Dataflow job from a template.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "projectId": {
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/templates",
- "id": "dataflow.projects.templates.create",
- "path": "v1b3/projects/{projectId}/templates"
+ "id": "dataflow.projects.templates.get",
+ "description": "Get the template associated with a template."
}
}
},
@@ -173,17 +177,17 @@
],
"httpMethod": "POST",
"parameters": {
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job",
+ "required": true,
+ "type": "string"
+ },
"projectId": {
"description": "The project to send the WorkerMessages to.",
"required": true,
"type": "string",
"location": "path"
- },
- "location": {
- "description": "The location which contains the job",
- "required": true,
- "type": "string",
- "location": "path"
}
},
"scopes": [
@@ -203,104 +207,19 @@
"resources": {
"templates": {
"methods": {
- "get": {
- "response": {
- "$ref": "GetTemplateResponse"
- },
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "description": "The location to which to direct the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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}/locations/{location}/templates:get",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates:get",
- "id": "dataflow.projects.locations.templates.get",
- "description": "Get the template associated with a template."
- },
- "create": {
- "description": "Creates a Cloud Dataflow job from a template.",
- "request": {
- "$ref": "CreateJobFromTemplateRequest"
- },
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "location": "path",
- "description": "The location to which to direct the request.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates",
- "id": "dataflow.projects.locations.templates.create"
- },
"launch": {
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
- "id": "dataflow.projects.locations.templates.launch",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
"request": {
"$ref": "LaunchTemplateParameters"
},
"description": "Launch a template.",
- "httpMethod": "POST",
+ "response": {
+ "$ref": "LaunchTemplateResponse"
+ },
"parameterOrder": [
"projectId",
"location"
],
- "response": {
- "$ref": "LaunchTemplateResponse"
- },
+ "httpMethod": "POST",
"parameters": {
"location": {
"location": "path",
@@ -309,19 +228,153 @@
"type": "string"
},
"validateOnly": {
+ "type": "boolean",
"location": "query",
- "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
- "type": "boolean"
+ "description": "If true, the request is validated but not actually executed.\nDefaults to false."
},
"projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "gcsPath": {
+ "type": "string",
+ "location": "query",
+ "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
+ "id": "dataflow.projects.locations.templates.launch"
+ },
+ "get": {
+ "description": "Get the template associated with a template.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "response": {
+ "$ref": "GetTemplateResponse"
+ },
+ "parameters": {
+ "gcsPath": {
+ "type": "string",
+ "location": "query",
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`."
+ },
+ "location": {
+ "location": "path",
+ "description": "The location to which to direct the request.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "view": {
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "METADATA_ONLY"
+ ],
+ "description": "The view to retrieve. Defaults to METADATA_ONLY."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get",
+ "id": "dataflow.projects.locations.templates.get",
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates:get"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "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"
},
- "gcsPath": {
+ "location": {
+ "description": "The location to which to direct the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates",
+ "id": "dataflow.projects.locations.templates.create",
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates",
+ "description": "Creates a Cloud Dataflow job from a template.",
+ "request": {
+ "$ref": "CreateJobFromTemplateRequest"
+ }
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "getMetrics": {
+ "id": "dataflow.projects.locations.jobs.getMetrics",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
+ "description": "Request the job status.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "JobMetrics"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "A project id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job to get messages for.",
+ "required": true,
+ "type": "string"
+ },
+ "location": {
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "startTime": {
"location": "query",
- "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.",
+ "description": "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"
}
},
@@ -329,34 +382,28 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/userinfo.email"
- ]
- }
- }
- },
- "jobs": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
],
- "httpMethod": "GET",
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics"
+ },
+ "get": {
"parameters": {
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "location": {
+ "description": "The location that contains this job.",
"required": true,
"type": "string",
"location": "path"
},
- "jobId": {
- "required": true,
- "type": "string",
+ "projectId": {
"location": "path",
- "description": "The job ID."
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job ID.",
+ "required": true,
+ "type": "string"
},
"view": {
"location": "query",
@@ -368,12 +415,6 @@
],
"description": "The level of information requested in response.",
"type": "string"
- },
- "location": {
- "location": "path",
- "description": "The location that contains this job.",
- "required": true,
- "type": "string"
}
},
"scopes": [
@@ -382,25 +423,29 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
"id": "dataflow.projects.locations.jobs.get",
- "description": "Gets the state of the specified Cloud Dataflow job."
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
+ "description": "Gets the state of the specified Cloud Dataflow job.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ]
},
"list": {
"description": "List the jobs of a project.",
- "response": {
- "$ref": "ListJobsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"projectId",
"location"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
"parameters": {
"filter": {
"location": "query",
@@ -420,18 +465,17 @@
"location": "path"
},
"pageToken": {
- "location": "query",
"description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.",
- "type": "string"
- },
- "pageSize": {
- "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
- "format": "int32",
- "type": "integer",
+ "type": "string",
"location": "query"
},
+ "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": {
- "type": "string",
"location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
@@ -439,65 +483,69 @@
"JOB_VIEW_ALL",
"JOB_VIEW_DESCRIPTION"
],
- "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`."
+ "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
+ "type": "string"
},
"projectId": {
- "location": "path",
"description": "The project which owns the jobs.",
"required": true,
- "type": "string"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "id": "dataflow.projects.locations.jobs.list"
- },
- "update": {
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "id": "dataflow.projects.locations.jobs.update",
- "description": "Updates the state of an existing Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to."
- },
- "jobId": {
- "location": "path",
- "description": "The job ID.",
- "required": true,
- "type": "string"
- },
- "location": {
- "description": "The location that contains this job.",
- "required": true,
"type": "string",
"location": "path"
}
},
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
+ "id": "dataflow.projects.locations.jobs.list",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs"
+ },
+ "update": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The job ID."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "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}",
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Updates the state of an existing Cloud Dataflow job.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ }
},
"create": {
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "id": "dataflow.projects.locations.jobs.create",
"description": "Creates a Cloud Dataflow job.",
"request": {
"$ref": "Job"
@@ -523,17 +571,18 @@
"type": "string"
},
"replaceJobId": {
+ "type": "string",
"location": "query",
- "description": "Deprecated. This field is now in the Job message.",
- "type": "string"
+ "description": "Deprecated. This field is now in the Job message."
},
"projectId": {
- "location": "path",
"description": "The ID of the Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"view": {
+ "type": "string",
"location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
@@ -541,72 +590,31 @@
"JOB_VIEW_ALL",
"JOB_VIEW_DESCRIPTION"
],
- "description": "The level of information requested in response.",
- "type": "string"
+ "description": "The level of information requested in response."
}
},
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs"
- },
- "getMetrics": {
- "description": "Request the job status.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "response": {
- "$ref": "JobMetrics"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "location": "path",
- "description": "The location which contains the job specified by job_id.",
- "required": true,
- "type": "string"
- },
- "startTime": {
- "location": "query",
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
- "format": "google-datetime",
- "type": "string"
- },
- "projectId": {
- "description": "A project id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The job to get messages for."
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
- "id": "dataflow.projects.locations.jobs.getMetrics",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics"
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
+ "id": "dataflow.projects.locations.jobs.create"
}
},
"resources": {
"debug": {
"methods": {
"getConfig": {
- "httpMethod": "POST",
+ "request": {
+ "$ref": "GetDebugConfigRequest"
+ },
+ "description": "Get encoded debug configuration for component. Not cacheable.",
+ "response": {
+ "$ref": "GetDebugConfigResponse"
+ },
"parameterOrder": [
"projectId",
"location",
"jobId"
],
- "response": {
- "$ref": "GetDebugConfigResponse"
- },
+ "httpMethod": "POST",
"parameters": {
"projectId": {
"description": "The project id.",
@@ -621,10 +629,10 @@
"location": "path"
},
"location": {
+ "location": "path",
"description": "The location which contains the job specified by job_id.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -633,18 +641,14 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
- "id": "dataflow.projects.locations.jobs.debug.getConfig",
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
- "request": {
- "$ref": "GetDebugConfigRequest"
- },
- "description": "Get encoded debug configuration for component. Not cacheable."
+ "id": "dataflow.projects.locations.jobs.debug.getConfig"
},
"sendCapture": {
- "description": "Send encoded debug capture data for component.",
"request": {
"$ref": "SendDebugCaptureRequest"
},
+ "description": "Send encoded debug capture data for component.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -654,31 +658,31 @@
"response": {
"$ref": "SendDebugCaptureResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"parameters": {
+ "projectId": {
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job id.",
+ "required": true,
+ "type": "string"
+ },
"location": {
"location": "path",
"description": "The location which contains the job specified by job_id.",
"required": true,
"type": "string"
- },
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The project id."
- },
- "jobId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The job id."
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
"id": "dataflow.projects.locations.jobs.debug.sendCapture",
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture"
@@ -688,13 +692,6 @@
"workItems": {
"methods": {
"reportStatus": {
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
- "id": "dataflow.projects.locations.jobs.workItems.reportStatus",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
- "request": {
- "$ref": "ReportWorkItemStatusRequest"
- },
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -706,10 +703,10 @@
},
"parameters": {
"projectId": {
- "location": "path",
"description": "The project which owns the WorkItem's job.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"jobId": {
"location": "path",
@@ -718,23 +715,26 @@
"type": "string"
},
"location": {
- "location": "path",
"description": "The location which contains the WorkItem's job.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/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."
},
"lease": {
- "request": {
- "$ref": "LeaseWorkItemRequest"
- },
- "description": "Leases a dataflow WorkItem to run.",
"response": {
"$ref": "LeaseWorkItemResponse"
},
@@ -746,10 +746,10 @@
"httpMethod": "POST",
"parameters": {
"location": {
- "location": "path",
"description": "The location which contains the WorkItem's job.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"projectId": {
"description": "Identifies the project this worker belongs to.",
@@ -771,14 +771,17 @@
],
"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"
+ "id": "dataflow.projects.locations.jobs.workItems.lease",
+ "request": {
+ "$ref": "LeaseWorkItemRequest"
+ },
+ "description": "Leases a dataflow WorkItem to run."
}
}
},
"messages": {
"methods": {
"list": {
- "description": "Request the job status.",
"response": {
"$ref": "ListJobMessagesResponse"
},
@@ -789,35 +792,6 @@
],
"httpMethod": "GET",
"parameters": {
- "endTime": {
- "location": "query",
- "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).",
- "format": "google-datetime",
- "type": "string"
- },
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
- "type": "string"
- },
- "startTime": {
- "location": "query",
- "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
- "format": "google-datetime",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
- "format": "int32",
- "type": "integer"
- },
"minimumImportance": {
"location": "query",
"enum": [
@@ -831,17 +805,46 @@
"description": "Filter to only get messages with importance \u003e= level",
"type": "string"
},
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "A project id."
- },
"jobId": {
- "location": "path",
"description": "The job to get messages about.",
"required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "A project id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
"type": "string"
+ },
+ "endTime": {
+ "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"
}
},
"scopes": [
@@ -851,7 +854,8 @@
],
"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
- "id": "dataflow.projects.locations.jobs.messages.list"
+ "id": "dataflow.projects.locations.jobs.messages.list",
+ "description": "Request the job status."
}
}
}
@@ -862,20 +866,29 @@
"jobs": {
"methods": {
"getMetrics": {
- "httpMethod": "GET",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.jobs.getMetrics",
+ "description": "Request the job status.",
+ "response": {
+ "$ref": "JobMetrics"
+ },
"parameterOrder": [
"projectId",
"jobId"
],
- "response": {
- "$ref": "JobMetrics"
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
+ "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.",
@@ -883,51 +896,54 @@
"type": "string"
},
"jobId": {
+ "location": "path",
"description": "The job to get messages for.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"location": {
- "type": "string",
- "location": "query",
- "description": "The location which contains the job specified by job_id."
- },
- "startTime": {
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
- "format": "google-datetime",
+ "description": "The location which contains the job specified by job_id.",
"type": "string",
"location": "query"
}
},
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
- "id": "dataflow.projects.jobs.getMetrics",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
- "description": "Request the job status."
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics"
},
"get": {
+ "description": "Gets the state of the specified Cloud Dataflow job.",
+ "response": {
+ "$ref": "Job"
+ },
"parameterOrder": [
"projectId",
"jobId"
],
"httpMethod": "GET",
- "response": {
- "$ref": "Job"
- },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
+ "location": {
+ "location": "query",
+ "description": "The location that contains this job.",
+ "type": "string"
+ },
"projectId": {
- "location": "path",
"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"
},
- "jobId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The job ID."
- },
"view": {
+ "location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
"JOB_VIEW_SUMMARY",
@@ -935,64 +951,48 @@
"JOB_VIEW_DESCRIPTION"
],
"description": "The level of information requested in response.",
- "type": "string",
- "location": "query"
- },
- "location": {
- "type": "string",
- "location": "query",
- "description": "The location that contains this job."
+ "type": "string"
}
},
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "id": "dataflow.projects.jobs.get"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}",
- "id": "dataflow.projects.jobs.get",
- "description": "Gets the state of the specified Cloud Dataflow job."
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"parameters": {
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
- "type": "string"
- },
"projectId": {
+ "location": "path",
"description": "The project which owns the jobs.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"filter": {
- "type": "string",
- "location": "query",
"enum": [
"UNKNOWN",
"ALL",
"TERMINATED",
"ACTIVE"
],
- "description": "The kind of filter to use."
+ "description": "The kind of filter to use.",
+ "type": "string",
+ "location": "query"
},
"location": {
- "location": "query",
"description": "The location that contains this job.",
- "type": "string"
+ "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.",
@@ -1004,19 +1004,23 @@
"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`."
}
},
"flatPath": "v1b3/projects/{projectId}/jobs",
"id": "dataflow.projects.jobs.list",
"path": "v1b3/projects/{projectId}/jobs",
- "description": "List the jobs of a project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameterOrder": [
- "projectId"
- ]
+ "description": "List the jobs of a project."
},
"update": {
"response": {
@@ -1027,17 +1031,7 @@
"jobId"
],
"httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"parameters": {
- "location": {
- "description": "The location that contains this job.",
- "type": "string",
- "location": "query"
- },
"projectId": {
"description": "The ID of the Cloud Platform project that the job belongs to.",
"required": true,
@@ -1049,32 +1043,45 @@
"required": true,
"type": "string",
"location": "path"
+ },
+ "location": {
+ "location": "query",
+ "description": "The location that contains this job.",
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"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": {
- "flatPath": "v1b3/projects/{projectId}/jobs",
- "id": "dataflow.projects.jobs.create",
- "path": "v1b3/projects/{projectId}/jobs",
"request": {
"$ref": "Job"
},
- "description": "Creates a Cloud Dataflow job.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
+ "description": "Updates the state of an existing Cloud Dataflow job."
+ },
+ "create": {
"response": {
"$ref": "Job"
},
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
"parameters": {
+ "location": {
+ "description": "The location that contains this job.",
+ "type": "string",
+ "location": "query"
+ },
+ "replaceJobId": {
+ "location": "query",
+ "description": "Deprecated. This field is now in the Job message.",
+ "type": "string"
+ },
"projectId": {
"required": true,
"type": "string",
@@ -1091,23 +1098,20 @@
"JOB_VIEW_ALL",
"JOB_VIEW_DESCRIPTION"
]
- },
- "location": {
- "location": "query",
- "description": "The location that contains this job.",
- "type": "string"
- },
- "replaceJobId": {
- "location": "query",
- "description": "Deprecated. This field is now in the Job message.",
- "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/userinfo.email"
- ]
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs",
+ "path": "v1b3/projects/{projectId}/jobs",
+ "id": "dataflow.projects.jobs.create",
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Creates a Cloud Dataflow job."
}
},
"resources": {
@@ -1122,6 +1126,11 @@
"jobId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
"projectId": {
"location": "path",
@@ -1130,126 +1139,115 @@
"type": "string"
},
"jobId": {
+ "location": "path",
"description": "The job id.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
"path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
"id": "dataflow.projects.jobs.debug.getConfig",
+ "description": "Get encoded debug configuration for component. Not cacheable.",
"request": {
"$ref": "GetDebugConfigRequest"
- },
- "description": "Get encoded debug configuration for component. Not cacheable."
+ }
},
"sendCapture": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "description": "The project id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "description": "The job id.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
- "id": "dataflow.projects.jobs.debug.sendCapture",
- "description": "Send encoded debug capture data for component.",
- "request": {
- "$ref": "SendDebugCaptureRequest"
- },
- "response": {
- "$ref": "SendDebugCaptureResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"jobId"
],
- "httpMethod": "POST"
+ "response": {
+ "$ref": "SendDebugCaptureResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job id.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
+ "id": "dataflow.projects.jobs.debug.sendCapture",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
+ "request": {
+ "$ref": "SendDebugCaptureRequest"
+ },
+ "description": "Send encoded debug capture data for component."
}
}
},
"workItems": {
"methods": {
- "lease": {
- "httpMethod": "POST",
+ "reportStatus": {
+ "response": {
+ "$ref": "ReportWorkItemStatusResponse"
+ },
"parameterOrder": [
"projectId",
"jobId"
],
- "response": {
- "$ref": "LeaseWorkItemResponse"
+ "httpMethod": "POST",
+ "parameters": {
+ "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"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/userinfo.email"
],
- "parameters": {
- "projectId": {
- "description": "Identifies the project this worker belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "description": "Identifies the workflow job this worker belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "id": "dataflow.projects.jobs.workItems.lease",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "description": "Leases a dataflow WorkItem to run.",
- "request": {
- "$ref": "LeaseWorkItemRequest"
- }
- },
- "reportStatus": {
- "id": "dataflow.projects.jobs.workItems.reportStatus",
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
"path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
+ "id": "dataflow.projects.jobs.workItems.reportStatus",
"request": {
"$ref": "ReportWorkItemStatusRequest"
},
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
- "httpMethod": "POST",
+ "description": "Reports the status of dataflow WorkItems leased by a worker."
+ },
+ "lease": {
+ "response": {
+ "$ref": "LeaseWorkItemResponse"
+ },
"parameterOrder": [
"projectId",
"jobId"
],
- "response": {
- "$ref": "ReportWorkItemStatusResponse"
- },
+ "httpMethod": "POST",
"parameters": {
"projectId": {
- "description": "The project which owns the WorkItem's job.",
+ "location": "path",
+ "description": "Identifies the project this worker belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"jobId": {
"location": "path",
- "description": "The job which the WorkItem is part of.",
+ "description": "Identifies the workflow job this worker belongs to.",
"required": true,
"type": "string"
}
@@ -1259,44 +1257,62 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus"
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
+ "id": "dataflow.projects.jobs.workItems.lease",
+ "request": {
+ "$ref": "LeaseWorkItemRequest"
+ },
+ "description": "Leases a dataflow WorkItem to run."
}
}
},
"messages": {
"methods": {
"list": {
- "response": {
- "$ref": "ListJobMessagesResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"projectId",
"jobId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListJobMessagesResponse"
+ },
"parameters": {
- "location": {
- "description": "The location which contains the job specified by job_id.",
+ "projectId": {
+ "description": "A project id.",
+ "required": true,
"type": "string",
- "location": "query"
+ "location": "path"
},
- "endTime": {
+ "jobId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The job to get messages about."
+ },
+ "location": {
"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",
+ "description": "The location which contains the job specified by job_id.",
"type": "string"
},
- "startTime": {
+ "endTime": {
+ "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).",
+ "format": "google-datetime",
"type": "string",
- "location": "query",
- "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"
+ "location": "query"
},
"pageToken": {
"location": "query",
"description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
"type": "string"
},
+ "startTime": {
+ "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.",
@@ -1315,18 +1331,6 @@
"JOB_MESSAGE_WARNING",
"JOB_MESSAGE_ERROR"
]
- },
- "jobId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The job to get messages about."
- },
- "projectId": {
- "location": "path",
- "description": "A project id.",
- "required": true,
- "type": "string"
}
},
"scopes": [
@@ -1335,8 +1339,8 @@
"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",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
"description": "Request the job status."
}
}
@@ -1347,31 +1351,10 @@
}
},
"parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
@@ -1379,15 +1362,15 @@
"location": "query"
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
@@ -1395,16 +1378,12 @@
"location": "query"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1414,7 +1393,11 @@
"1",
"2"
],
- "description": "V1 error format.",
+ "description": "V1 error format."
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"alt": {
@@ -1432,48 +1415,743 @@
"proto"
],
"type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
}
},
"schemas": {
+ "MetricStructuredName": {
+ "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"
+ }
+ },
+ "origin": {
+ "description": "Origin (namespace) of metric name. May be blank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Dataflow service or SDK.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Worker-defined metric name.",
+ "type": "string"
+ }
+ },
+ "id": "MetricStructuredName",
+ "description": "Identifies a metric, by describing the source which generated the\nmetric.",
+ "type": "object"
+ },
+ "SeqMapTaskOutputInfo": {
+ "type": "object",
+ "properties": {
+ "tag": {
+ "description": "The id of the TupleTag the user code will tag the output value by.",
+ "type": "string"
+ },
+ "sink": {
+ "description": "The sink to write the output value to.",
+ "$ref": "Sink"
+ }
+ },
+ "id": "SeqMapTaskOutputInfo",
+ "description": "Information about an output of a SeqMapTask."
+ },
+ "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"
+ }
+ }
+ },
+ "id": "JobExecutionStageInfo"
+ },
+ "KeyRangeLocation": {
+ "description": "Location information for a specific key-range of a sharded computation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.",
+ "type": "object",
+ "properties": {
+ "end": {
+ "description": "The end (exclusive) of the key range.",
+ "type": "string"
+ },
+ "deprecatedPersistentDirectory": {
+ "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem.",
+ "type": "string"
+ },
+ "deliveryEndpoint": {
+ "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.",
+ "type": "string"
+ },
+ "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": "KeyRangeLocation"
+ },
+ "SourceGetMetadataRequest": {
+ "description": "A request to compute the SourceMetadata of a Source.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "description": "Specification of the source whose metadata should be computed.",
+ "$ref": "Source"
+ }
+ },
+ "id": "SourceGetMetadataRequest"
+ },
+ "NameAndKind": {
+ "description": "Basic metadata about a counter.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the counter.",
+ "type": "string"
+ },
+ "kind": {
+ "enum": [
+ "INVALID",
+ "SUM",
+ "MAX",
+ "MIN",
+ "MEAN",
+ "OR",
+ "AND",
+ "SET",
+ "DISTRIBUTION"
+ ],
+ "description": "Counter aggregation kind.",
+ "type": "string",
+ "enumDescriptions": [
+ "Counter aggregation kind was not set.",
+ "Aggregated value is the sum of all contributed values.",
+ "Aggregated value is the max of all contributed values.",
+ "Aggregated value is the min of all contributed values.",
+ "Aggregated value is the mean of all contributed values.",
+ "Aggregated value represents the logical 'or' of all contributed values.",
+ "Aggregated value represents the logical 'and' of all contributed values.",
+ "Aggregated value is a set of unique contributed values.",
+ "Aggregated value captures statistics about a distribution."
+ ]
+ }
+ },
+ "id": "NameAndKind"
+ },
+ "SeqMapTask": {
+ "description": "Describes a particular function to invoke.",
+ "type": "object",
+ "properties": {
+ "systemName": {
+ "description": "System-defined name of the SeqDo operation.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "stageName": {
+ "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "userFn": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The user function to invoke.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The user-provided name of the SeqDo operation.",
+ "type": "string"
+ },
+ "outputInfos": {
+ "description": "Information about each of the outputs.",
+ "type": "array",
+ "items": {
+ "$ref": "SeqMapTaskOutputInfo"
+ }
+ },
+ "inputs": {
+ "description": "Information about each of the inputs.",
+ "type": "array",
+ "items": {
+ "$ref": "SideInputInfo"
+ }
+ }
+ },
+ "id": "SeqMapTask"
+ },
+ "WorkerMessageCode": {
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ }
+ },
+ "code": {
+ "description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.",
+ "type": "string"
+ }
+ },
+ "id": "WorkerMessageCode",
+ "description": "A message code is used to report status and error messages to the service.\nThe message codes are intended to be machine readable. The service will\ntake care of translating these into user understandable messages if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successful startup.\n 2. Worker processes reporting specific errors (e.g. package staging\n failure)."
+ },
+ "CustomSourceLocation": {
+ "description": "Identifies the location of a custom souce.",
+ "type": "object",
+ "properties": {
+ "stateful": {
+ "description": "Whether this source is stateful.",
+ "type": "boolean"
+ }
+ },
+ "id": "CustomSourceLocation"
+ },
+ "MapTask": {
+ "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.",
+ "type": "object",
+ "properties": {
+ "systemName": {
+ "description": "System-defined name of this MapTask.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "stageName": {
+ "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "instructions": {
+ "description": "The instructions in the MapTask.",
+ "type": "array",
+ "items": {
+ "$ref": "ParallelInstruction"
+ }
+ }
+ },
+ "id": "MapTask"
+ },
+ "FloatingPointMean": {
+ "id": "FloatingPointMean",
+ "description": "A representation of a floating point mean metric contribution.",
+ "type": "object",
+ "properties": {
+ "sum": {
+ "description": "The sum of all values being aggregated.",
+ "format": "double",
+ "type": "number"
+ },
+ "count": {
+ "$ref": "SplitInt64",
+ "description": "The number of values being aggregated."
+ }
+ }
+ },
+ "ReportWorkItemStatusResponse": {
+ "properties": {
+ "workItemServiceStates": {
+ "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.",
+ "type": "array",
+ "items": {
+ "$ref": "WorkItemServiceState"
+ }
+ }
+ },
+ "id": "ReportWorkItemStatusResponse",
+ "description": "Response from a request to report the status of WorkItems.",
+ "type": "object"
+ },
+ "InstructionOutput": {
+ "description": "An output of an instruction.",
+ "type": "object",
+ "properties": {
+ "onlyCountValueBytes": {
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.",
+ "type": "boolean"
+ },
+ "codec": {
+ "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"
+ },
+ "systemName": {
+ "description": "System-defined name of this output.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "onlyCountKeyBytes": {
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.",
+ "type": "boolean"
+ }
+ },
+ "id": "InstructionOutput"
+ },
+ "CreateJobFromTemplateRequest": {
+ "description": "A request to create a Cloud Dataflow job from a template.",
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "description": "The runtime parameters to pass to the job.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "jobName": {
+ "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://`."
+ },
+ "environment": {
+ "$ref": "RuntimeEnvironment",
+ "description": "The runtime environment for the job."
+ },
+ "location": {
+ "description": "The location to which to direct the request.",
+ "type": "string"
+ }
+ },
+ "id": "CreateJobFromTemplateRequest"
+ },
+ "IntegerMean": {
+ "id": "IntegerMean",
+ "description": "A representation of an integer mean metric contribution.",
+ "type": "object",
+ "properties": {
+ "count": {
+ "$ref": "SplitInt64",
+ "description": "The number of values being aggregated."
+ },
+ "sum": {
+ "description": "The sum of all values being aggregated.",
+ "$ref": "SplitInt64"
+ }
+ }
+ },
+ "ListJobsResponse": {
+ "description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest.",
+ "type": "object",
+ "properties": {
+ "jobs": {
+ "description": "A subset of the requested job information.",
+ "type": "array",
+ "items": {
+ "$ref": "Job"
+ }
+ },
+ "nextPageToken": {
+ "description": "Set if there may be more results than fit in this response.",
+ "type": "string"
+ },
+ "failedLocation": {
+ "description": "Zero or more messages describing locations that failed to respond.",
+ "type": "array",
+ "items": {
+ "$ref": "FailedLocation"
+ }
+ }
+ },
+ "id": "ListJobsResponse"
+ },
+ "ComputationTopology": {
+ "type": "object",
+ "properties": {
+ "systemStageName": {
+ "description": "The system stage name.",
+ "type": "string"
+ },
+ "computationId": {
+ "description": "The ID of the computation.",
+ "type": "string"
+ },
+ "inputs": {
+ "description": "The inputs to the computation.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamLocation"
+ }
+ },
+ "keyRanges": {
+ "description": "The key ranges processed by the computation.",
+ "type": "array",
+ "items": {
+ "$ref": "KeyRangeLocation"
+ }
+ },
+ "outputs": {
+ "description": "The outputs from the computation.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamLocation"
+ }
+ },
+ "stateFamilies": {
+ "description": "The state family values.",
+ "type": "array",
+ "items": {
+ "$ref": "StateFamilyConfig"
+ }
+ }
+ },
+ "id": "ComputationTopology",
+ "description": "All configuration data for a particular Computation."
+ },
+ "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"
+ },
+ "bypassTempDirValidation": {
+ "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
+ "type": "boolean"
+ },
+ "serviceAccountEmail": {
+ "type": "string",
+ "description": "The email address of the service account to run the job as."
+ },
+ "tempLocation": {
+ "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
+ "type": "string"
+ },
+ "machineType": {
+ "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.",
+ "type": "string"
+ }
+ },
+ "id": "RuntimeEnvironment",
+ "description": "The environment values to set at runtime.",
+ "type": "object"
+ },
+ "MountedDataDisk": {
+ "id": "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"
+ }
+ }
+ },
+ "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": {
+ "type": "string",
+ "description": "Identifies the state family where this side input is stored."
+ }
+ },
+ "id": "StreamingSideInputLocation"
+ },
+ "LaunchTemplateResponse": {
+ "description": "Response to the request to launch a template.",
+ "type": "object",
+ "properties": {
+ "job": {
+ "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched.",
+ "$ref": "Job"
+ }
+ },
+ "id": "LaunchTemplateResponse"
+ },
+ "Job": {
+ "id": "Job",
+ "description": "Defines a job to be run by the Cloud Dataflow service.",
+ "type": "object",
+ "properties": {
+ "currentStateTime": {
+ "description": "The timestamp associated with the current state.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "transformNameMapping": {
+ "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "environment": {
+ "$ref": "Environment",
+ "description": "The environment for the job."
+ },
+ "createTime": {
+ "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "stageStates": {
+ "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
+ "type": "array",
+ "items": {
+ "$ref": "ExecutionStageState"
+ }
+ },
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "The type of the job is unspecified, or unknown.",
+ "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.",
+ "A continuously streaming job with no end: data is read,\nprocessed, and written continuously."
+ ],
+ "enum": [
+ "JOB_TYPE_UNKNOWN",
+ "JOB_TYPE_BATCH",
+ "JOB_TYPE_STREAMING"
+ ],
+ "description": "The type of Cloud Dataflow job.",
+ "type": "string"
+ },
+ "pipelineDescription": {
+ "$ref": "PipelineDescription",
+ "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL."
+ },
+ "replaceJobId": {
+ "type": "string",
+ "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job."
+ },
+ "requestedState": {
+ "enum": [
+ "JOB_STATE_UNKNOWN",
+ "JOB_STATE_STOPPED",
+ "JOB_STATE_RUNNING",
+ "JOB_STATE_DONE",
+ "JOB_STATE_FAILED",
+ "JOB_STATE_CANCELLED",
+ "JOB_STATE_UPDATED",
+ "JOB_STATE_DRAINING",
+ "JOB_STATE_DRAINED",
+ "JOB_STATE_PENDING",
+ "JOB_STATE_CANCELLING"
+ ],
+ "description": "The job's requested state.\n\n`UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the\njob if it has not already reached a terminal state.",
+ "type": "string",
+ "enumDescriptions": [
+ "The job's run state isn't specified.",
+ "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
+ "`JOB_STATE_RUNNING` indicates that the job is currently running.",
+ "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
+ "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
+ "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
+ "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
+ "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
+ "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
+ "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
+ "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
+ ]
+ },
+ "tempFiles": {
+ "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "clientRequestId": {
+ "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`",
+ "type": "string"
+ },
+ "steps": {
+ "description": "The top-level steps that constitute the entire job.",
+ "type": "array",
+ "items": {
+ "$ref": "Step"
+ }
+ },
+ "replacedByJobId": {
+ "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
+ "type": "string"
+ },
+ "executionInfo": {
+ "description": "Deprecated.",
+ "$ref": "JobExecutionInfo"
+ },
+ "id": {
+ "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.",
+ "type": "string"
+ },
+ "currentState": {
+ "description": "The current state of the job.\n\nJobs are created in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nThis field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
+ "type": "string",
+ "enumDescriptions": [
+ "The job's run state isn't specified.",
+ "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
+ "`JOB_STATE_RUNNING` indicates that the job is currently running.",
+ "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
+ "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
+ "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
+ "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
+ "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
+ "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
+ "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
+ "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
+ ],
+ "enum": [
+ "JOB_STATE_UNKNOWN",
+ "JOB_STATE_STOPPED",
+ "JOB_STATE_RUNNING",
+ "JOB_STATE_DONE",
+ "JOB_STATE_FAILED",
+ "JOB_STATE_CANCELLED",
+ "JOB_STATE_UPDATED",
+ "JOB_STATE_DRAINING",
+ "JOB_STATE_DRAINED",
+ "JOB_STATE_PENDING",
+ "JOB_STATE_CANCELLING"
+ ]
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "type": "string"
+ }
+ }
+ },
+ "DynamicSourceSplit": {
+ "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",
+ "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input.",
+ "type": "object"
+ },
+ "DerivedSource": {
+ "type": "object",
+ "properties": {
+ "derivationMode": {
+ "description": "What source to base the produced source on (if any).",
+ "type": "string",
+ "enumDescriptions": [
+ "The source derivation is unknown, or unspecified.",
+ "Produce a completely independent Source with no base.",
+ "Produce a Source based on the Source being split.",
+ "Produce a Source based on the base of the Source being split."
+ ],
+ "enum": [
+ "SOURCE_DERIVATION_MODE_UNKNOWN",
+ "SOURCE_DERIVATION_MODE_INDEPENDENT",
+ "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
+ "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
+ ]
+ },
+ "source": {
+ "description": "Specification of the source.",
+ "$ref": "Source"
+ }
+ },
+ "id": "DerivedSource",
+ "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."
+ },
"SourceOperationResponse": {
+ "id": "SourceOperationResponse",
"description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.",
"type": "object",
"properties": {
"getMetadata": {
- "description": "A response to a request to get metadata about a source.",
- "$ref": "SourceGetMetadataResponse"
+ "$ref": "SourceGetMetadataResponse",
+ "description": "A response to a request to get metadata about a source."
},
"split": {
"$ref": "SourceSplitResponse",
"description": "A response to a request to split a source."
}
- },
- "id": "SourceOperationResponse"
+ }
},
"SendDebugCaptureResponse": {
- "id": "SendDebugCaptureResponse",
- "description": "Response to a send capture request.\nnothing",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "SendDebugCaptureResponse",
+ "description": "Response to a send capture request.\nnothing"
},
"SideInputInfo": {
"description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
"type": "object",
"properties": {
"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"
- },
- "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": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
- "description": "How to interpret the source element(s) as a side input value.",
- "type": "object"
+ "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.",
@@ -1482,28 +2160,28 @@
},
"id": "SideInputInfo"
},
- "CounterStructuredNameAndMetadata": {
+ "WriteInstruction": {
+ "description": "An instruction that writes records.\nTakes one input, produces no outputs.",
+ "type": "object",
"properties": {
- "name": {
- "$ref": "CounterStructuredName",
- "description": "Structured name of the counter."
+ "sink": {
+ "$ref": "Sink",
+ "description": "The sink to write to."
},
- "metadata": {
- "description": "Metadata associated with a counter",
- "$ref": "CounterMetadata"
+ "input": {
+ "$ref": "InstructionInput",
+ "description": "The input."
}
},
- "id": "CounterStructuredNameAndMetadata",
- "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
- "type": "object"
+ "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": {
- "description": "Position within the inner source.",
- "$ref": "Position"
+ "$ref": "Position",
+ "description": "Position within the inner source."
},
"index": {
"description": "Index of the inner source.",
@@ -1513,22 +2191,49 @@
},
"id": "ConcatPosition"
},
- "WriteInstruction": {
- "description": "An instruction that writes records.\nTakes one input, produces no outputs.",
+ "CounterStructuredNameAndMetadata": {
"type": "object",
"properties": {
- "input": {
- "description": "The input.",
- "$ref": "InstructionInput"
+ "name": {
+ "$ref": "CounterStructuredName",
+ "description": "Structured name of the counter."
},
- "sink": {
- "$ref": "Sink",
- "description": "The sink to write to."
+ "metadata": {
+ "$ref": "CounterMetadata",
+ "description": "Metadata associated with a counter"
}
},
- "id": "WriteInstruction"
+ "id": "CounterStructuredNameAndMetadata",
+ "description": "A single message which encapsulates structured name and metadata for a given\ncounter."
+ },
+ "AutoscalingSettings": {
+ "properties": {
+ "maxNumWorkers": {
+ "description": "The maximum number of workers to cap scaling at.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "id": "AutoscalingSettings",
+ "description": "Settings for WorkerPool autoscaling.",
+ "type": "object"
},
"StreamingComputationRanges": {
+ "description": "Describes full or partial data disk assignment information of the computation\nranges.",
"type": "object",
"properties": {
"rangeAssignments": {
@@ -1543,34 +2248,7 @@
"type": "string"
}
},
- "id": "StreamingComputationRanges",
- "description": "Describes full or partial data disk assignment information of the computation\nranges."
- },
- "AutoscalingSettings": {
- "type": "object",
- "properties": {
- "algorithm": {
- "type": "string",
- "enumDescriptions": [
- "The algorithm is unknown, or unspecified.",
- "Disable autoscaling.",
- "Increase worker count over time to reduce job execution time."
- ],
- "enum": [
- "AUTOSCALING_ALGORITHM_UNKNOWN",
- "AUTOSCALING_ALGORITHM_NONE",
- "AUTOSCALING_ALGORITHM_BASIC"
- ],
- "description": "The algorithm to use for autoscaling."
- },
- "maxNumWorkers": {
- "description": "The maximum number of workers to cap scaling at.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AutoscalingSettings",
- "description": "Settings for WorkerPool autoscaling."
+ "id": "StreamingComputationRanges"
},
"ExecutionStageSummary": {
"type": "object",
@@ -1598,11 +2276,11 @@
"type": "string"
},
"componentTransform": {
+ "description": "Transforms that comprise this execution stage.",
"type": "array",
"items": {
"$ref": "ComponentTransform"
- },
- "description": "Transforms that comprise this execution stage."
+ }
},
"componentSource": {
"description": "Collections produced and consumed by component transforms of this stage.",
@@ -1612,6 +2290,17 @@
}
},
"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",
@@ -1624,23 +2313,29 @@
"SHUFFLE_KIND"
],
"description": "Type of tranform this stage is executing.",
- "type": "string",
- "enumDescriptions": [
- "Unrecognized transform type.",
- "ParDo transform.",
- "Group By Key transform.",
- "Flatten transform.",
- "Read transform.",
- "Write transform.",
- "Constructs from a constant value, such as with Create.of.",
- "Creates a Singleton view of a collection.",
- "Opening or closing a shuffle session, often as part of a GroupByKey."
- ]
+ "type": "string"
}
},
"id": "ExecutionStageSummary",
"description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sources may have been\ngenerated by the Dataflow service during execution planning."
},
+ "LogBucket": {
+ "description": "Bucket of values for Distribution's logarithmic histogram.",
+ "type": "object",
+ "properties": {
+ "log": {
+ "description": "floor(log2(value)); defined to be zero for nonpositive values.\n log(-1) = 0\n log(0) = 0\n log(1) = 0\n log(2) = 1\n log(3) = 1\n log(4) = 2\n log(5) = 2",
+ "format": "int32",
+ "type": "integer"
+ },
+ "count": {
+ "description": "Number of values in this bucket.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "LogBucket"
+ },
"SendWorkerMessagesRequest": {
"description": "A request for sending worker messages to the service.",
"type": "object",
@@ -1659,29 +2354,11 @@
},
"id": "SendWorkerMessagesRequest"
},
- "LogBucket": {
- "description": "Bucket of values for Distribution's logarithmic histogram.",
- "type": "object",
- "properties": {
- "log": {
- "description": "floor(log2(value)); defined to be zero for nonpositive values.\n log(-1) = 0\n log(0) = 0\n log(1) = 0\n log(2) = 1\n log(3) = 1\n log(4) = 2\n log(5) = 2",
- "format": "int32",
- "type": "integer"
- },
- "count": {
- "description": "Number of values in this bucket.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "LogBucket"
- },
"SourceSplitShard": {
- "id": "SourceSplitShard",
- "description": "DEPRECATED in favor of DerivedSource.",
"type": "object",
"properties": {
"derivationMode": {
+ "description": "DEPRECATED",
"type": "string",
"enumDescriptions": [
"The source derivation is unknown, or unspecified.",
@@ -1694,24 +2371,18 @@
"SOURCE_DERIVATION_MODE_INDEPENDENT",
"SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
"SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ],
- "description": "DEPRECATED"
+ ]
},
"source": {
"description": "DEPRECATED",
"$ref": "Source"
}
- }
+ },
+ "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",
@@ -1721,29 +2392,36 @@
"description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
"format": "double",
"type": "number"
+ },
+ "timestamp": {
+ "description": "Timestamp of the measurement.",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "CPUTime"
+ "id": "CPUTime",
+ "description": "Modeled after information exposed by /proc/stat.",
+ "type": "object"
},
"Environment": {
"description": "Describes the environment in which a Dataflow Job runs.",
"type": "object",
"properties": {
"userAgent": {
- "description": "A description of the process that generated the request.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
+ },
+ "description": "A description of the process that generated the request."
},
"sdkPipelineOptions": {
+ "type": "object",
"additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
+ "type": "any",
+ "description": "Properties of the object."
},
- "description": "The Cloud Dataflow SDK pipeline options specified by the user. These\noptions are passed through the service and are used to recreate the\nSDK pipeline options on the worker in a language agnostic and platform\nindependent way.",
- "type": "object"
+ "description": "The Cloud Dataflow SDK pipeline options specified by the user. These\noptions are passed through the service and are used to recreate the\nSDK pipeline options on the worker in a language agnostic and platform\nindependent way."
},
"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\".",
@@ -1754,15 +2432,15 @@
"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"
- }
+ },
+ "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers."
},
"dataset": {
- "type": "string",
- "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}"
+ "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}",
+ "type": "string"
},
"experiments": {
"description": "The list of experiments to enable.",
@@ -1795,23 +2473,22 @@
"id": "Environment"
},
"StreamingComputationTask": {
- "id": "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"
+ "type": "string",
+ "enumDescriptions": [
+ "The streaming computation task is unknown, or unspecified.",
+ "Stop processing specified streaming computation range(s).",
+ "Start processing specified streaming computation range(s)."
+ ]
},
"computationRanges": {
"description": "Contains ranges of a streaming computation this task should apply to.",
@@ -1827,9 +2504,11 @@
"$ref": "MountedDataDisk"
}
}
- }
+ },
+ "id": "StreamingComputationTask"
},
"SendDebugCaptureRequest": {
+ "description": "Request to send encoded debug information.",
"type": "object",
"properties": {
"componentId": {
@@ -1837,8 +2516,8 @@
"type": "string"
},
"workerId": {
- "type": "string",
- "description": "The worker id, i.e., VM hostname."
+ "description": "The worker id, i.e., VM hostname.",
+ "type": "string"
},
"location": {
"description": "The location which contains the job specified by job_id.",
@@ -1849,40 +2528,41 @@
"type": "string"
}
},
- "id": "SendDebugCaptureRequest",
- "description": "Request to send encoded debug information."
+ "id": "SendDebugCaptureRequest"
},
"GetDebugConfigResponse": {
"description": "Response to a get debug configuration request.",
"type": "object",
"properties": {
"config": {
- "type": "string",
- "description": "The encoded debug configuration for the requested component."
+ "description": "The encoded debug configuration for the requested component.",
+ "type": "string"
}
},
"id": "GetDebugConfigResponse"
},
"ComponentTransform": {
+ "description": "Description of a transform executed as part of an execution stage.",
+ "type": "object",
"properties": {
"originalTransform": {
"description": "User name for the original user transform with which this transform is\nmost closely associated.",
"type": "string"
},
"name": {
- "description": "Dataflow service generated name for this source.",
- "type": "string"
+ "type": "string",
+ "description": "Dataflow service generated name for this source."
},
"userName": {
"description": "Human-readable name for this transform; may be user or system generated.",
"type": "string"
}
},
- "id": "ComponentTransform",
- "description": "Description of a transform executed as part of an execution stage.",
- "type": "object"
+ "id": "ComponentTransform"
},
"StreamingSetupTask": {
+ "description": "A task which initializes part of a streaming Dataflow job.",
+ "type": "object",
"properties": {
"streamingComputationTopology": {
"$ref": "TopologyConfig",
@@ -1903,9 +2583,7 @@
"type": "integer"
}
},
- "id": "StreamingSetupTask",
- "description": "A task which initializes part of a streaming Dataflow job.",
- "type": "object"
+ "id": "StreamingSetupTask"
},
"PubsubLocation": {
"description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
@@ -1943,8 +2621,6 @@
"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": {
@@ -1959,9 +2635,9 @@
}
},
"vmStartupTime": {
+ "type": "string",
"description": "The time the VM was booted.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"vmIsHealthy": {
"description": "Whether the VM is healthy.",
@@ -1972,21 +2648,35 @@
"format": "google-duration",
"type": "string"
}
- }
+ },
+ "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."
},
"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": "Deprecated.",
"type": "string"
},
"messageText": {
- "type": "string",
- "description": "The text of the message."
+ "description": "The text of the message.",
+ "type": "string"
},
"messageImportance": {
+ "enumDescriptions": [
+ "The message importance isn't specified, or is unknown.",
+ "The message is at the 'debug' level: typically only useful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default.",
+ "The message is at the 'detailed' level: somewhat verbose, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do not display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.",
+ "The message is at the 'basic' level: useful for keeping\ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are displayed by default in the\nDataflow monitoring UI.",
+ "The message is at the 'warning' level: indicating a condition\npertaining to a job which may require human intervention.\nTypically, Dataflow pipeline runners display log messages at this\nlevel by default, and these messages are displayed by default in\nthe Dataflow monitoring UI.",
+ "The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI."
+ ],
"enum": [
"JOB_MESSAGE_IMPORTANCE_UNKNOWN",
"JOB_MESSAGE_DEBUG",
@@ -1996,28 +2686,24 @@
"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"
+ "id": "JobMessage",
+ "description": "A particular message pertaining to a Dataflow job."
},
"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",
@@ -2032,14 +2718,6 @@
"helpText": {
"description": "Required. The help text to display for the parameter.",
"type": "string"
- },
- "isOptional": {
- "description": "Optional. Whether the parameter is optional. Defaults to false.",
- "type": "boolean"
- },
- "name": {
- "description": "Required. The name of the parameter.",
- "type": "string"
}
},
"id": "ParameterMetadata"
@@ -2056,58 +2734,42 @@
"id": "MultiOutputInfo"
},
"SourceSplitRequest": {
+ "type": "object",
"properties": {
"source": {
- "$ref": "Source",
- "description": "Specification of the source to be split."
+ "description": "Specification of the source to be split.",
+ "$ref": "Source"
},
"options": {
- "$ref": "SourceSplitOptions",
- "description": "Hints for tuning the splitting process."
+ "description": "Hints for tuning the splitting process.",
+ "$ref": "SourceSplitOptions"
}
},
"id": "SourceSplitRequest",
- "description": "Represents the operation to split a high-level Source specification\ninto bundles (parts for parallel processing).\n\nAt a high level, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it.",
- "type": "object"
+ "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."
},
"SourceGetMetadataResponse": {
- "description": "The result of a SourceGetMetadataOperation.",
- "type": "object",
"properties": {
"metadata": {
"description": "The computed metadata.",
"$ref": "SourceMetadata"
}
},
- "id": "SourceGetMetadataResponse"
+ "id": "SourceGetMetadataResponse",
+ "description": "The result of a SourceGetMetadataOperation.",
+ "type": "object"
},
"AutoscalingEvent": {
+ "id": "AutoscalingEvent",
"description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice.",
"type": "object",
"properties": {
- "description": {
- "description": "A message describing why the system decided to adjust the current\nnumber of workers, why it failed, or why the system decided to\nnot make any changes to the number of workers.",
- "$ref": "StructuredMessage"
- },
- "time": {
- "type": "string",
- "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.",
- "format": "google-datetime"
- },
"targetNumWorkers": {
"description": "The target number of workers the worker pool wants to resize to use.",
"format": "int64",
"type": "string"
},
"eventType": {
- "type": "string",
- "enumDescriptions": [
- "Default type for the enum. Value should never be returned.",
- "The TARGET_NUM_WORKERS_CHANGED type should be used when the target\nworker pool size has changed at the start of an actuation. An event\nshould always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects\na change in the target_num_workers.",
- "The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker\npool size has been changed, but the target_num_workers has not changed.",
- "The ACTUATION_FAILURE type should be used when we want to report\nan error to the user indicating why the current number of workers\nin the pool could not be changed.\nDisplayed in the current status and history widgets.",
- "Used when we want to report to the user a reason why we are\nnot currently adjusting the number of workers.\nShould specify both target_num_workers, current_num_workers and a\ndecision_message."
- ],
"enum": [
"TYPE_UNKNOWN",
"TARGET_NUM_WORKERS_CHANGED",
@@ -2115,24 +2777,40 @@
"ACTUATION_FAILURE",
"NO_CHANGE"
],
- "description": "The type of autoscaling event to report."
+ "description": "The type of autoscaling event to report.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default type for the enum. Value should never be returned.",
+ "The TARGET_NUM_WORKERS_CHANGED type should be used when the target\nworker pool size has changed at the start of an actuation. An event\nshould always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects\na change in the target_num_workers.",
+ "The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker\npool size has been changed, but the target_num_workers has not changed.",
+ "The ACTUATION_FAILURE type should be used when we want to report\nan error to the user indicating why the current number of workers\nin the pool could not be changed.\nDisplayed in the current status and history widgets.",
+ "Used when we want to report to the user a reason why we are\nnot currently adjusting the number of workers.\nShould specify both target_num_workers, current_num_workers and a\ndecision_message."
+ ]
},
"currentNumWorkers": {
"description": "The current number of workers the job has.",
"format": "int64",
"type": "string"
+ },
+ "description": {
+ "$ref": "StructuredMessage",
+ "description": "A message describing why the system decided to adjust the current\nnumber of workers, why it failed, or why the system decided to\nnot make any changes to the number of workers."
+ },
+ "time": {
+ "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.",
+ "format": "google-datetime",
+ "type": "string"
}
- },
- "id": "AutoscalingEvent"
+ }
},
"MetricShortId": {
"description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest",
"type": "object",
"properties": {
"metricIndex": {
+ "type": "integer",
"description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"shortId": {
"description": "The service-generated short identifier for the metric.",
@@ -2144,14 +2822,14 @@
},
"ShellTask": {
"properties": {
- "command": {
- "description": "The shell command to run.",
- "type": "string"
- },
"exitCode": {
"description": "Exit code for the task.",
"format": "int32",
"type": "integer"
+ },
+ "command": {
+ "description": "The shell command to run.",
+ "type": "string"
}
},
"id": "ShellTask",
@@ -2163,8 +2841,8 @@
"type": "object",
"properties": {
"alsologtostderr": {
- "type": "boolean",
- "description": "Whether to also send taskrunner log info to stderr."
+ "description": "Whether to also send taskrunner log info to stderr.",
+ "type": "boolean"
},
"taskGroup": {
"description": "The UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\".",
@@ -2178,20 +2856,20 @@
"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": {
"type": "string",
"description": "The API version of endpoint, e.g. \"v1b3\""
},
- "oauthScopes": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API."
- },
"streamingWorkerMainClass": {
- "description": "The streaming worker main class name.",
- "type": "string"
+ "type": "string",
+ "description": "The streaming worker main class name."
},
"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}",
@@ -2230,16 +2908,16 @@
"type": "boolean"
},
"parallelWorkerSettings": {
- "$ref": "WorkerSettings",
- "description": "The settings to pass to the parallel worker harness."
- },
- "taskUser": {
- "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
- "type": "string"
+ "description": "The settings to pass to the parallel worker harness.",
+ "$ref": "WorkerSettings"
},
"vmId": {
"description": "The ID string of the VM.",
"type": "string"
+ },
+ "taskUser": {
+ "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
+ "type": "string"
}
},
"id": "TaskRunnerSettings"
@@ -2249,26 +2927,26 @@
"type": "object",
"properties": {
"recordIndex": {
- "type": "string",
"description": "Position is a record index.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"shufflePosition": {
- "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).",
- "type": "string"
+ "type": "string",
+ "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding)."
+ },
+ "concatPosition": {
+ "$ref": "ConcatPosition",
+ "description": "CloudPosition is a concat position."
},
"byteOffset": {
"description": "Position is a byte offset.",
"format": "int64",
"type": "string"
},
- "concatPosition": {
- "$ref": "ConcatPosition",
- "description": "CloudPosition is a concat position."
- },
"end": {
- "type": "boolean",
- "description": "Position is past all other positions. Also useful for the end\nposition of an unbounded range."
+ "description": "Position is past all other positions. Also useful for the end\nposition of an unbounded range.",
+ "type": "boolean"
},
"key": {
"description": "Position is a string key, ordered lexicographically.",
@@ -2277,23 +2955,40 @@
},
"id": "Position"
},
+ "SplitInt64": {
+ "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.",
+ "type": "object",
+ "properties": {
+ "highBits": {
+ "description": "The high order bits, including the sign: n \u003e\u003e 32.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "lowBits": {
+ "description": "The low order bits: n & 0xffffffff.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "id": "SplitInt64"
+ },
"Source": {
"description": "A source that records can be read and decoded from.",
"type": "object",
"properties": {
"metadata": {
- "$ref": "SourceMetadata",
- "description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see SourceOperationRequest).\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated."
+ "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"
},
"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"
- },
- "type": "object"
+ }
}
},
"codec": {
@@ -2305,137 +3000,25 @@
"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."
+ "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": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
- "description": "The source to read from, plus its parameters.",
- "type": "object"
+ "description": "The source to read from, plus its parameters."
}
},
"id": "Source"
},
- "SplitInt64": {
- "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.",
- "type": "object",
- "properties": {
- "lowBits": {
- "description": "The low order bits: n & 0xffffffff.",
- "format": "uint32",
- "type": "integer"
- },
- "highBits": {
- "description": "The high order bits, including the sign: n \u003e\u003e 32.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "SplitInt64"
- },
"WorkerPool": {
"description": "Describes one particular pool of Cloud Dataflow workers to be\ninstantiated by the Cloud Dataflow service in order to perform the\ncomputations required by a job. Note that a workflow job may use\nmultiple pools, in order to match the various computational\nrequirements of the various stages of the job.",
"type": "object",
"properties": {
- "kind": {
- "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
- "type": "string"
- },
- "dataDisks": {
- "description": "Data disks that are used by a VM in this workflow.",
- "type": "array",
- "items": {
- "$ref": "Disk"
- }
- },
- "subnetwork": {
- "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\".",
- "type": "string"
- },
- "ipConfiguration": {
- "description": "Configuration for VM IPs.",
- "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"
- ]
- },
- "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": {
- "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"
- },
- "numThreadsPerWorker": {
- "type": "integer",
- "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"
- },
- "zone": {
- "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.",
- "type": "string"
- },
- "numWorkers": {
- "description": "Number of Google Compute Engine workers in this pool needed to\nexecute the job. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
- "format": "int32",
- "type": "integer"
- },
- "diskSourceImage": {
- "description": "Fully qualified source image for disks.",
- "type": "string"
- },
- "packages": {
- "description": "Packages to be installed on workers.",
- "type": "array",
- "items": {
- "$ref": "Package"
- }
- },
"teardownPolicy": {
- "enumDescriptions": [
- "The teardown policy isn't specified, or is unknown.",
- "Always teardown the resource.",
- "Teardown the resource on success. This is useful for debugging\nfailures.",
- "Never teardown the resource. This is useful for debugging and\ndevelopment."
- ],
"enum": [
"TEARDOWN_POLICY_UNKNOWN",
"TEARDOWN_ALWAYS",
@@ -2443,24 +3026,30 @@
"TEARDOWN_NEVER"
],
"description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The teardown policy isn't specified, or is unknown.",
+ "Always teardown the resource.",
+ "Teardown the resource on success. This is useful for debugging\nfailures.",
+ "Never teardown the resource. This is useful for debugging and\ndevelopment."
+ ]
},
"onHostMaintenance": {
"description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API.",
"type": "string"
},
"poolArgs": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
- "description": "Extra arguments for this worker pool."
+ "description": "Extra arguments for this worker pool.",
+ "type": "object"
},
"diskSizeGb": {
- "type": "integer",
"description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"workerHarnessContainerImage": {
"description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
@@ -2473,51 +3062,127 @@
"machineType": {
"description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.",
"type": "string"
+ },
+ "kind": {
+ "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
+ "type": "string"
+ },
+ "dataDisks": {
+ "description": "Data disks that are used by a VM in this workflow.",
+ "type": "array",
+ "items": {
+ "$ref": "Disk"
+ }
+ },
+ "subnetwork": {
+ "type": "string",
+ "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\"."
+ },
+ "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"
+ },
+ "network": {
+ "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\".",
+ "type": "string"
+ },
+ "defaultPackageSet": {
+ "enumDescriptions": [
+ "The default set of packages to stage is unknown, or unspecified.",
+ "Indicates that no packages should be staged at the worker unless\nexplicitly specified by the job.",
+ "Stage packages typically useful to workers written in Java.",
+ "Stage pacakges typically useful to workers written in Python."
+ ],
+ "enum": [
+ "DEFAULT_PACKAGE_SET_UNKNOWN",
+ "DEFAULT_PACKAGE_SET_NONE",
+ "DEFAULT_PACKAGE_SET_JAVA",
+ "DEFAULT_PACKAGE_SET_PYTHON"
+ ],
+ "description": "The default package set to install. This allows the service to\nselect a default set of packages which are useful to worker\nharnesses written in a particular language.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.",
+ "type": "string"
+ },
+ "numThreadsPerWorker": {
+ "description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according to the number of cores\non the selected machine type for batch, or 1 by convention for streaming).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "numWorkers": {
+ "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"
+ },
+ "diskSourceImage": {
+ "description": "Fully qualified source image for disks.",
+ "type": "string"
+ },
+ "packages": {
+ "description": "Packages to be installed on workers.",
+ "type": "array",
+ "items": {
+ "$ref": "Package"
+ }
}
},
"id": "WorkerPool"
},
"SourceOperationRequest": {
- "properties": {
- "getMetadata": {
- "description": "Information about a request to get metadata about a source.",
- "$ref": "SourceGetMetadataRequest"
- },
- "split": {
- "$ref": "SourceSplitRequest",
- "description": "Information about a request to split a source."
- }
- },
- "id": "SourceOperationRequest",
"description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
- "type": "object"
- },
- "StructuredMessage": {
- "description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption.",
"type": "object",
"properties": {
- "messageKey": {
- "type": "string",
- "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message."
+ "split": {
+ "description": "Information about a request to split a source.",
+ "$ref": "SourceSplitRequest"
},
- "messageText": {
- "type": "string",
- "description": "Human-readable version of message."
- },
- "parameters": {
- "description": "The structured data associated with this message.",
- "type": "array",
- "items": {
- "$ref": "Parameter"
- }
+ "getMetadata": {
+ "$ref": "SourceGetMetadataRequest",
+ "description": "Information about a request to get metadata about a source."
}
},
- "id": "StructuredMessage"
+ "id": "SourceOperationRequest"
},
"WorkItem": {
"description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.",
"type": "object",
"properties": {
+ "jobId": {
+ "description": "Identifies the workflow job this WorkItem belongs to.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifies this WorkItem.",
+ "format": "int64",
+ "type": "string"
+ },
"configuration": {
"description": "Work item-specific configuration as an opaque blob.",
"type": "string"
@@ -2527,8 +3192,8 @@
"description": "Additional information for MapTask WorkItems."
},
"seqMapTask": {
- "description": "Additional information for SeqMapTask WorkItems.",
- "$ref": "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.",
@@ -2554,14 +3219,14 @@
"format": "google-duration",
"type": "string"
},
- "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",
- "type": "string"
+ "format": "google-datetime"
+ },
+ "streamingConfigTask": {
+ "description": "Additional information for StreamingConfigTask WorkItems.",
+ "$ref": "StreamingConfigTask"
},
"initialReportIndex": {
"description": "The initial index to use when reporting the status of the WorkItem.",
@@ -2569,38 +3234,37 @@
"type": "string"
},
"shellTask": {
- "description": "Additional information for ShellTask WorkItems.",
- "$ref": "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": {
- "description": "Identifies this WorkItem.",
- "format": "int64",
- "type": "string"
}
},
"id": "WorkItem"
},
- "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.",
+ "StructuredMessage": {
+ "description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption.",
"type": "object",
"properties": {
- "cpuTime": {
- "description": "CPU utilization samples.",
+ "messageKey": {
+ "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.",
+ "type": "string"
+ },
+ "messageText": {
+ "description": "Human-readable version of message.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "The structured data associated with this message.",
"type": "array",
"items": {
- "$ref": "CPUTime"
+ "$ref": "Parameter"
}
}
},
- "id": "ResourceUtilizationReport"
+ "id": "StructuredMessage"
},
"ReportedParallelism": {
"description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
@@ -2611,23 +3275,37 @@
"type": "boolean"
},
"value": {
+ "type": "number",
"description": "Specifies the level of parallelism in case it is finite.",
- "format": "double",
- "type": "number"
+ "format": "double"
}
},
"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": {
"userStageToComputationNameMap": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Maps user stage names to stable computation names."
+ "description": "Maps user stage names to stable computation names.",
+ "type": "object"
},
"computations": {
"description": "The computations associated with a streaming Dataflow job.",
@@ -2637,11 +3315,11 @@
}
},
"dataDiskAssignments": {
+ "description": "The disks assigned to a streaming Dataflow job.",
"type": "array",
"items": {
"$ref": "DataDiskAssignment"
- },
- "description": "The disks assigned to a streaming Dataflow job."
+ }
},
"persistentStateVersion": {
"description": "Version number for persistent state.",
@@ -2649,15 +3327,14 @@
"type": "integer"
},
"forwardingKeyBits": {
+ "type": "integer",
"description": "The size (in bits) of keys that will be assigned to source messages.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
"id": "TopologyConfig"
},
"SourceSplitOptions": {
- "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
"type": "object",
"properties": {
"desiredBundleSizeBytes": {
@@ -2671,7 +3348,8 @@
"type": "string"
}
},
- "id": "SourceSplitOptions"
+ "id": "SourceSplitOptions",
+ "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest."
},
"ReadInstruction": {
"description": "An instruction that reads records.\nTakes no inputs, produces one output.",
@@ -2685,9 +3363,26 @@
"id": "ReadInstruction"
},
"WorkerSettings": {
+ "id": "WorkerSettings",
"description": "Provides data to pass through to the worker harness.",
"type": "object",
"properties": {
+ "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"
@@ -2695,57 +3390,39 @@
"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"
- },
- "reportingEnabled": {
- "description": "Whether to send work progress updates to the service.",
- "type": "boolean"
- },
- "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"
- },
- "servicePath": {
- "type": "string",
- "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\"."
- },
- "shuffleServicePath": {
- "description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\".",
- "type": "string"
}
- },
- "id": "WorkerSettings"
+ }
},
"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"
}
- },
- "vmInstance": {
- "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".",
- "type": "string"
}
},
- "id": "DataDiskAssignment",
- "description": "Data disk assignment for a given VM instance.",
- "type": "object"
+ "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"
+ "id": "StreamingStageLocation",
+ "description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication.",
+ "type": "object"
},
"ApproximateSplitRequest": {
- "description": "A suggestion by the service to the worker to dynamically split the WorkItem.",
"type": "object",
"properties": {
"position": {
@@ -2753,29 +3430,18 @@
"$ref": "Position"
},
"fractionConsumed": {
- "type": "number",
"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"
+ "format": "double",
+ "type": "number"
}
},
- "id": "ApproximateSplitRequest"
+ "id": "ApproximateSplitRequest",
+ "description": "A suggestion by the service to the worker to dynamically split the WorkItem."
},
"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.",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "details": {
- "description": "A list of messages that carry the error details. There 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",
@@ -2784,13 +3450,30 @@
"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"
},
"ExecutionStageState": {
"description": "A message describing the state of a particular execution stage.",
"type": "object",
"properties": {
+ "currentStateTime": {
+ "description": "The time at which the stage transitioned to this state.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"executionStageState": {
"enumDescriptions": [
"The job's run state isn't specified.",
@@ -2822,12 +3505,7 @@
"type": "string"
},
"executionStageName": {
- "type": "string",
- "description": "The name of the execution stage."
- },
- "currentStateTime": {
- "description": "The time at which the stage transitioned to this state.",
- "format": "google-datetime",
+ "description": "The name of the execution stage.",
"type": "string"
}
},
@@ -2850,8 +3528,8 @@
"description": "The stream is a pubsub stream."
},
"sideInputLocation": {
- "description": "The stream is a streaming side input.",
- "$ref": "StreamingSideInputLocation"
+ "$ref": "StreamingSideInputLocation",
+ "description": "The stream is a streaming side input."
}
},
"id": "StreamLocation"
@@ -2871,6 +3549,7 @@
"id": "SendWorkerMessagesResponse"
},
"LeaseWorkItemResponse": {
+ "description": "Response to a request to lease WorkItems.",
"type": "object",
"properties": {
"workItems": {
@@ -2881,8 +3560,7 @@
}
}
},
- "id": "LeaseWorkItemResponse",
- "description": "Response to a request to lease WorkItems."
+ "id": "LeaseWorkItemResponse"
},
"TransformSummary": {
"description": "Description of the type, names/ids, and input/outputs for a transform.",
@@ -2893,11 +3571,11 @@
"type": "string"
},
"displayData": {
+ "description": "Transform-specific display data.",
"type": "array",
"items": {
"$ref": "DisplayData"
- },
- "description": "Transform-specific display data."
+ }
},
"outputCollectionName": {
"description": "User names for all collection outputs to this transform.",
@@ -2907,8 +3585,6 @@
}
},
"kind": {
- "description": "Type of transform.",
- "type": "string",
"enumDescriptions": [
"Unrecognized transform type.",
"ParDo transform.",
@@ -2930,14 +3606,16 @@
"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"
- },
- "description": "User names for all collection inputs to this transform."
+ }
},
"name": {
"description": "User provided name for this transform instance.",
@@ -2947,6 +3625,8 @@
"id": "TransformSummary"
},
"StreamingComputationConfig": {
+ "description": "Configuration information for a single streaming computation.",
+ "type": "object",
"properties": {
"computationId": {
"description": "Unique identifier for this computation.",
@@ -2957,8 +3637,8 @@
"type": "string"
},
"stageName": {
- "type": "string",
- "description": "Stage name of this computation."
+ "description": "Stage name of this computation.",
+ "type": "string"
},
"instructions": {
"description": "Instructions that comprise the computation.",
@@ -2968,20 +3648,16 @@
}
}
},
- "id": "StreamingComputationConfig",
- "description": "Configuration information for a single streaming computation.",
- "type": "object"
+ "id": "StreamingComputationConfig"
},
"LaunchTemplateParameters": {
- "description": "Parameters to provide to the template being launched.",
- "type": "object",
"properties": {
"parameters": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "The runtime parameters to pass to the job.",
- "type": "object"
+ "description": "The runtime parameters to pass to the job."
},
"jobName": {
"description": "Required. The job name to use for the created job.",
@@ -2992,19 +3668,20 @@
"description": "The runtime environment for the job."
}
},
- "id": "LaunchTemplateParameters"
+ "id": "LaunchTemplateParameters",
+ "description": "Parameters to provide to the template being launched.",
+ "type": "object"
},
"Sink": {
- "description": "A sink that records can be encoded and written to.",
"type": "object",
"properties": {
"codec": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
- "description": "The codec to use to encode data written to the sink."
+ "description": "The codec to use to encode data written to the sink.",
+ "type": "object"
},
"spec": {
"description": "The sink to write to, plus its parameters.",
@@ -3015,7 +3692,8 @@
}
}
},
- "id": "Sink"
+ "id": "Sink",
+ "description": "A sink that records can be encoded and written to."
},
"FlattenInstruction": {
"description": "An instruction that copies its inputs (zero or more) to its (single) output.",
@@ -3035,22 +3713,6 @@
"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": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The value combining function to invoke.",
- "type": "object"
- },
"originalCombineValuesInputStoreName": {
"description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues.",
"type": "string"
@@ -3069,35 +3731,45 @@
"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": {
+ "description": "The value combining function to invoke.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
}
},
"id": "PartialGroupByKeyInstruction"
},
"InstructionInput": {
+ "id": "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",
- "type": "integer"
+ "format": "int32"
},
"outputNum": {
"description": "The output index (origin zero) within the producer.",
"format": "int32",
"type": "integer"
}
- },
- "id": "InstructionInput",
- "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
- "type": "object"
+ }
},
"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"
@@ -3110,9 +3782,15 @@
"userName": {
"description": "Human-readable name for this source; may be user or system generated.",
"type": "string"
+ },
+ "originalTransformOrCollection": {
+ "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
+ "type": "string"
}
},
- "id": "StageSource"
+ "id": "StageSource",
+ "description": "Description of an input or output of an execution stage.",
+ "type": "object"
},
"StringList": {
"description": "A metric value representing a list of strings.",
@@ -3132,27 +3810,10 @@
"description": "Data provided with a pipeline or transform to provide descriptive info.",
"type": "object",
"properties": {
- "timestampValue": {
- "description": "Contains value if the data is of timestamp type.",
- "format": "google-datetime",
- "type": "string"
- },
- "javaClassValue": {
- "description": "Contains value if the data is of java class type.",
- "type": "string"
- },
- "boolValue": {
- "description": "Contains value if the data is of a boolean type.",
- "type": "boolean"
- },
- "strValue": {
- "description": "Contains value if the data is of string type.",
- "type": "string"
- },
"int64Value": {
- "type": "string",
"description": "Contains value if the data is of int64 type.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"durationValue": {
"description": "Contains value if the data is of duration type.",
@@ -3164,30 +3825,48 @@
"type": "string"
},
"floatValue": {
- "type": "number",
"description": "Contains value if the data is of float type.",
- "format": "float"
+ "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"
},
"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"
+ "type": "string",
+ "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."
},
"url": {
- "description": "An optional full URL.",
- "type": "string"
+ "type": "string",
+ "description": "An optional full URL."
},
"label": {
"description": "An optional label to display in a dax UI for the element.",
"type": "string"
+ },
+ "timestampValue": {
+ "type": "string",
+ "description": "Contains value if the data is of timestamp type.",
+ "format": "google-datetime"
+ },
+ "boolValue": {
+ "description": "Contains value if the data is of a boolean type.",
+ "type": "boolean"
+ },
+ "javaClassValue": {
+ "description": "Contains value if the data is of java class type.",
+ "type": "string"
+ },
+ "strValue": {
+ "description": "Contains value if the data is of string type.",
+ "type": "string"
}
},
"id": "DisplayData"
},
"LeaseWorkItemRequest": {
+ "id": "LeaseWorkItemRequest",
"description": "Request to lease WorkItems.",
"type": "object",
"properties": {
@@ -3196,6 +3875,10 @@
"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",
@@ -3203,10 +3886,6 @@
"type": "string"
}
},
- "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",
@@ -3215,16 +3894,15 @@
}
},
"workerId": {
- "type": "string",
- "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker."
+ "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.",
@@ -3246,38 +3924,51 @@
"id": "GetDebugConfigRequest"
},
"GetTemplateResponse": {
+ "id": "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."
+ "description": "The template metadata describing the template name, available\nparameters, etc.",
+ "$ref": "TemplateMetadata"
},
"status": {
- "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details."
}
- },
- "id": "GetTemplateResponse"
+ }
},
"Parameter": {
+ "type": "object",
"properties": {
- "value": {
- "description": "Value for this parameter.",
- "type": "any"
- },
"key": {
"description": "Key or name for this parameter.",
"type": "string"
+ },
+ "value": {
+ "description": "Value for this parameter.",
+ "type": "any"
}
},
"id": "Parameter",
- "description": "Structured data associated with this message.",
- "type": "object"
+ "description": "Structured data associated with this message."
},
"ReportWorkItemStatusRequest": {
+ "id": "ReportWorkItemStatusRequest",
+ "description": "Request to report the status of WorkItems.",
"type": "object",
"properties": {
+ "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"
+ }
+ },
"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"
@@ -3286,26 +3977,46 @@
"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": {
+ }
+ }
+ },
+ "PipelineDescription": {
+ "type": "object",
+ "properties": {
+ "executionPipelineStage": {
+ "description": "Description of each stage of execution of the pipeline.",
"type": "array",
"items": {
- "$ref": "WorkItemStatus"
- },
- "description": "The order is unimportant, except that the order of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\ncorresponds to the order of WorkItemStatus messages here."
+ "$ref": "ExecutionStageSummary"
+ }
+ },
+ "originalPipelineTransform": {
+ "description": "Description of each transform in the pipeline and collections between them.",
+ "type": "array",
+ "items": {
+ "$ref": "TransformSummary"
+ }
+ },
+ "displayData": {
+ "description": "Pipeline level display data.",
+ "type": "array",
+ "items": {
+ "$ref": "DisplayData"
+ }
}
},
- "id": "ReportWorkItemStatusRequest",
- "description": "Request to report the status of WorkItems."
+ "id": "PipelineDescription",
+ "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics."
},
"StreamingConfigTask": {
"description": "A task that carries configuration information for streaming computations.",
"type": "object",
"properties": {
+ "windmillServicePort": {
+ "description": "If present, the worker must use this port to communicate with Windmill\nService dispatchers. Only applicable when windmill_service_endpoint is\nspecified.",
+ "format": "int64",
+ "type": "string"
+ },
"streamingComputationConfigs": {
"description": "Set of computation configuration information.",
"type": "array",
@@ -3323,44 +4034,36 @@
},
"description": "Map from user step names to state families.",
"type": "object"
- },
- "windmillServicePort": {
- "description": "If present, the worker must use this port to communicate with Windmill\nService dispatchers. Only applicable when windmill_service_endpoint is\nspecified.",
- "format": "int64",
- "type": "string"
}
},
"id": "StreamingConfigTask"
},
- "PipelineDescription": {
- "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics.",
+ "Step": {
+ "description": "Defines a particular step within a Cloud Dataflow job.\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n * Read a collection of data from some source, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce.",
"type": "object",
"properties": {
- "displayData": {
- "description": "Pipeline level display data.",
- "type": "array",
- "items": {
- "$ref": "DisplayData"
- }
+ "properties": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "Named properties associated with the step. Each kind of\npredefined step has its own required set of properties.\nMust be provided on Create. Only retrieved with JOB_VIEW_ALL.",
+ "type": "object"
},
- "executionPipelineStage": {
- "description": "Description of each stage of execution of the pipeline.",
- "type": "array",
- "items": {
- "$ref": "ExecutionStageSummary"
- }
+ "name": {
+ "type": "string",
+ "description": "The name that identifies the step. This must be unique for each\nstep with respect to all other steps in the Cloud Dataflow job."
},
- "originalPipelineTransform": {
- "description": "Description of each transform in the pipeline and collections between them.",
- "type": "array",
- "items": {
- "$ref": "TransformSummary"
- }
+ "kind": {
+ "description": "The kind of step in the Cloud Dataflow job.",
+ "type": "string"
}
},
- "id": "PipelineDescription"
+ "id": "Step"
},
"JobExecutionInfo": {
+ "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.",
+ "type": "object",
"properties": {
"stages": {
"additionalProperties": {
@@ -3370,32 +4073,7 @@
"type": "object"
}
},
- "id": "JobExecutionInfo",
- "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.",
- "type": "object"
- },
- "Step": {
- "properties": {
- "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",
- "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"
+ "id": "JobExecutionInfo"
},
"FailedLocation": {
"description": "Indicates which location failed to respond to a request for data.",
@@ -3409,13 +4087,12 @@
"id": "FailedLocation"
},
"Disk": {
- "description": "Describes the data disk used by a workflow job.",
"type": "object",
"properties": {
"sizeGb": {
+ "type": "integer",
"description": "Size of disk in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"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",
@@ -3426,25 +4103,39 @@
"type": "string"
}
},
- "id": "Disk"
+ "id": "Disk",
+ "description": "Describes the data disk used by a workflow job."
+ },
+ "ListJobMessagesResponse": {
+ "description": "Response to a request to list job messages.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The token to obtain the next page of results if there are more.",
+ "type": "string"
+ },
+ "autoscalingEvents": {
+ "type": "array",
+ "items": {
+ "$ref": "AutoscalingEvent"
+ },
+ "description": "Autoscaling events in ascending timestamp order."
+ },
+ "jobMessages": {
+ "description": "Messages in ascending timestamp order.",
+ "type": "array",
+ "items": {
+ "$ref": "JobMessage"
+ }
+ }
+ },
+ "id": "ListJobMessagesResponse"
},
"CounterMetadata": {
"description": "CounterMetadata includes all static non-name non-value counter attributes.",
"type": "object",
"properties": {
"kind": {
- "enum": [
- "INVALID",
- "SUM",
- "MAX",
- "MIN",
- "MEAN",
- "OR",
- "AND",
- "SET",
- "DISTRIBUTION"
- ],
- "description": "Counter aggregation kind.",
"type": "string",
"enumDescriptions": [
"Counter aggregation kind was not set.",
@@ -3456,14 +4147,25 @@
"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": {
- "type": "string",
"enumDescriptions": [
"Counter returns a value in bytes.",
"Counter returns a value in bytes per second.",
@@ -3484,7 +4186,8 @@
"TIMESTAMP_USEC",
"TIMESTAMP_NSEC"
],
- "description": "System defined Units, see above enum."
+ "description": "System defined Units, see above enum.",
+ "type": "string"
},
"otherUnits": {
"description": "A string referring to the unit type.",
@@ -3493,38 +4196,18 @@
},
"id": "CounterMetadata"
},
- "ListJobMessagesResponse": {
- "description": "Response to a request to list job messages.",
- "type": "object",
- "properties": {
- "autoscalingEvents": {
- "description": "Autoscaling events in ascending timestamp order.",
- "type": "array",
- "items": {
- "$ref": "AutoscalingEvent"
- }
- },
- "jobMessages": {
- "description": "Messages in ascending timestamp order.",
- "type": "array",
- "items": {
- "$ref": "JobMessage"
- }
- },
- "nextPageToken": {
- "description": "The token to obtain the next page of results if there are more.",
- "type": "string"
- }
- },
- "id": "ListJobMessagesResponse"
- },
"ApproximateReportedProgress": {
+ "id": "ApproximateReportedProgress",
"description": "A progress measurement of a WorkItem by a worker.",
"type": "object",
"properties": {
+ "remainingParallelism": {
+ "$ref": "ReportedParallelism",
+ "description": "Total amount of parallelism in the input of this task that remains,\n(i.e. can be delegated to this task and any new tasks via dynamic\nsplitting). Always at least 1 for non-finished work items and 0 for\nfinished.\n\n\"Amount of parallelism\" refers to how many non-empty parts of the input\ncan be read in parallel. This does not necessarily equal number\nof records. An input that can be read in parallel down to the\nindividual records is called \"perfectly splittable\".\nAn example of non-perfectly parallelizable input is a block-compressed\nfile format where a block of records has to be read as a whole,\nbut different blocks can be read in parallel.\n\nExamples:\n* If we are processing record #30 (starting at 1) out of 50 in a perfectly\n splittable 50-record input, this value should be 21 (20 remaining + 1\n current).\n* If we are reading through block 3 in a block-compressed file consisting\n of 5 blocks, this value should be 3 (since blocks 4 and 5 can be\n processed in parallel by new tasks via dynamic splitting and the current\n task remains processing block 3).\n* If we are reading through the last block in a block-compressed file,\n or reading or processing the last record in a perfectly splittable\n input, this value should be 1, because apart from the current task, no\n additional remainder can be split off."
+ },
"position": {
- "$ref": "Position",
- "description": "A Position within the work to represent a progress."
+ "description": "A Position within the work to represent a progress.",
+ "$ref": "Position"
},
"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).",
@@ -3534,13 +4217,23 @@
"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."
}
- },
- "id": "ApproximateReportedProgress"
+ }
+ },
+ "StateFamilyConfig": {
+ "id": "StateFamilyConfig",
+ "description": "State family configuration.",
+ "type": "object",
+ "properties": {
+ "isRead": {
+ "description": "If true, this family corresponds to a read operation.",
+ "type": "boolean"
+ },
+ "stateFamily": {
+ "description": "The state family value.",
+ "type": "string"
+ }
+ }
},
"IntegerList": {
"type": "object",
@@ -3556,32 +4249,33 @@
"id": "IntegerList",
"description": "A metric value representing a list of integers."
},
- "StateFamilyConfig": {
- "properties": {
- "stateFamily": {
- "type": "string",
- "description": "The state family value."
- },
- "isRead": {
- "description": "If true, this family corresponds to a read operation.",
- "type": "boolean"
- }
- },
- "id": "StateFamilyConfig",
- "description": "State family configuration.",
- "type": "object"
- },
"ResourceUtilizationReportResponse": {
+ "description": "Service-side response to WorkerMessage reporting resource utilization.",
"type": "object",
"properties": {},
- "id": "ResourceUtilizationReportResponse",
- "description": "Service-side response to WorkerMessage reporting resource utilization."
+ "id": "ResourceUtilizationReportResponse"
},
"SourceSplitResponse": {
"description": "The response to a SourceSplitRequest.",
"type": "object",
"properties": {
+ "bundles": {
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "SourceSplitShard"
+ },
+ "description": "DEPRECATED in favor of bundles."
+ },
"outcome": {
+ "description": "Indicates whether splitting happened and produced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current source should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in this case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbundles into which the source was split.",
+ "type": "string",
"enumDescriptions": [
"The source split outcome is unknown, or unspecified.",
"The current source should be processed \"as is\" without splitting.",
@@ -3591,30 +4285,39 @@
"SOURCE_SPLIT_OUTCOME_UNKNOWN",
"SOURCE_SPLIT_OUTCOME_USE_CURRENT",
"SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED"
- ],
- "description": "Indicates whether splitting happened and produced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current source should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in this case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbundles into which the source was split.",
- "type": "string"
- },
- "bundles": {
- "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"
- }
+ ]
}
},
"id": "SourceSplitResponse"
},
"ParallelInstruction": {
+ "description": "Describes a particular operation comprising a MapTask.",
"type": "object",
"properties": {
+ "parDo": {
+ "description": "Additional information for ParDo instructions.",
+ "$ref": "ParDoInstruction"
+ },
+ "read": {
+ "description": "Additional information for Read instructions.",
+ "$ref": "ReadInstruction"
+ },
+ "flatten": {
+ "$ref": "FlattenInstruction",
+ "description": "Additional information for Flatten instructions."
+ },
+ "originalName": {
+ "description": "System-defined name for the operation in the original workflow graph.",
+ "type": "string"
+ },
+ "write": {
+ "$ref": "WriteInstruction",
+ "description": "Additional information for Write instructions."
+ },
+ "systemName": {
+ "description": "System-defined name of this operation.\nUnique across the workflow.",
+ "type": "string"
+ },
"partialGroupByKey": {
"$ref": "PartialGroupByKeyInstruction",
"description": "Additional information for PartialGroupByKey instructions."
@@ -3629,49 +4332,9 @@
"name": {
"description": "User-provided name of this operation.",
"type": "string"
- },
- "parDo": {
- "$ref": "ParDoInstruction",
- "description": "Additional information for ParDo instructions."
- },
- "read": {
- "description": "Additional information for Read instructions.",
- "$ref": "ReadInstruction"
- },
- "flatten": {
- "description": "Additional information for Flatten instructions.",
- "$ref": "FlattenInstruction"
- },
- "originalName": {
- "type": "string",
- "description": "System-defined name for the operation in the original workflow graph."
- },
- "write": {
- "description": "Additional information for Write instructions.",
- "$ref": "WriteInstruction"
- },
- "systemName": {
- "type": "string",
- "description": "System-defined name of this operation.\nUnique across the workflow."
}
},
- "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": {
- "location": {
- "type": "string",
- "description": "The resource to read the package from. The supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}\n bucket.storage.googleapis.com/"
- },
- "name": {
- "description": "The name of the package.",
- "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.",
@@ -3692,10 +4355,38 @@
},
"id": "KeyRangeDataDiskAssignment"
},
+ "Package": {
+ "description": "The packages that must be installed in order for a worker to run the\nsteps of the Cloud Dataflow job that will be assigned to its worker\npool.\n\nThis is the mechanism by which the Cloud Dataflow SDK causes code to\nbe loaded onto the workers. For example, the Cloud Dataflow Java SDK\nmight use this to install jars containing the user's code and all of the\nvarious dependencies (libraries, data files, etc.) required in order\nfor that code to run.",
+ "type": "object",
+ "properties": {
+ "location": {
+ "description": "The resource to read the package from. The supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}\n bucket.storage.googleapis.com/",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the package.",
+ "type": "string"
+ }
+ },
+ "id": "Package"
+ },
"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": {
+ "numOutputs": {
+ "description": "The number of outputs.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sideInputs": {
+ "description": "Zero or more side inputs.",
+ "type": "array",
+ "items": {
+ "$ref": "SideInputInfo"
+ }
+ },
"multiOutputInfos": {
"description": "Information about each of the outputs, if user_fn is a MultiDoFn.",
"type": "array",
@@ -3714,79 +4405,14 @@
"input": {
"$ref": "InstructionInput",
"description": "The input."
- },
- "numOutputs": {
- "description": "The number of outputs.",
- "format": "int32",
- "type": "integer"
- },
- "sideInputs": {
- "description": "Zero or more side inputs.",
- "type": "array",
- "items": {
- "$ref": "SideInputInfo"
- }
- }
- },
- "id": "ParDoInstruction"
- },
- "MetricUpdate": {
- "id": "MetricUpdate",
- "description": "Describes the state of a metric.",
- "type": "object",
- "properties": {
- "internal": {
- "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.",
- "type": "any"
- },
- "cumulative": {
- "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this metric is reported\nas a delta that is not associated with any WorkItem.",
- "type": "boolean"
- },
- "kind": {
- "description": "Metric aggregation kind. The possible metric aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value.",
- "type": "string"
- },
- "scalar": {
- "description": "Worker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value types are Long, Double, and Boolean.",
- "type": "any"
- },
- "meanCount": {
- "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the count of the aggregated values and is used in combination\nwith mean_sum above to obtain the actual mean aggregate value.\nThe only possible value type is Long.",
- "type": "any"
- },
- "meanSum": {
- "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the sum of the aggregated values and is used in combination\nwith mean_count below to obtain the actual mean aggregate value.\nThe only possible value types are Long and Double.",
- "type": "any"
- },
- "updateTime": {
- "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "$ref": "MetricStructuredName",
- "description": "Name of the metric."
- },
- "distribution": {
- "description": "A struct value describing properties of a distribution of numeric values.",
- "type": "any"
- },
- "set": {
- "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type.",
- "type": "any"
}
}
},
"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": {
+ "type": "string",
"enumDescriptions": [
"Counter portion has not been set.",
"Counter reports a key.",
@@ -3797,8 +4423,7 @@
"KEY",
"VALUE"
],
- "description": "Portion of this counter, either key or value.",
- "type": "string"
+ "description": "Portion of this counter, either key or value."
},
"originalStepName": {
"description": "System generated name of the original step in the user's graph, before\noptimization.",
@@ -3809,38 +4434,91 @@
"type": "string"
},
"originNamespace": {
- "type": "string",
- "description": "A string containing a more specific namespace of the counter's origin."
+ "description": "A string containing a more specific namespace of the counter's origin.",
+ "type": "string"
},
- "origin": {
- "type": "string",
- "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."
+ "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"
},
- "executionStepName": {
+ "origin": {
+ "enum": [
+ "SYSTEM",
+ "USER"
+ ],
+ "description": "One of the standard Origins defined above.",
"type": "string",
- "description": "Name of the stage. An execution step contains multiple component steps."
+ "enumDescriptions": [
+ "Counter was created by the Dataflow system.",
+ "Counter was created by the user."
+ ]
+ },
+ "componentStepName": {
+ "description": "Name of the optimized step being executed by the workers.",
+ "type": "string"
}
},
- "id": "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."
+ },
+ "MetricUpdate": {
+ "description": "Describes the state of a metric.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the metric.",
+ "$ref": "MetricStructuredName"
+ },
+ "distribution": {
+ "description": "A struct value describing properties of a distribution of numeric values.",
+ "type": "any"
+ },
+ "set": {
+ "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type.",
+ "type": "any"
+ },
+ "cumulative": {
+ "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this metric is reported\nas a delta that is not associated with any WorkItem.",
+ "type": "boolean"
+ },
+ "internal": {
+ "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.",
+ "type": "any"
+ },
+ "kind": {
+ "description": "Metric aggregation kind. The possible metric aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value.",
+ "type": "string"
+ },
+ "scalar": {
+ "type": "any",
+ "description": "Worker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value types are Long, Double, and Boolean."
+ },
+ "meanCount": {
+ "type": "any",
+ "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the count of the aggregated values and is used in combination\nwith mean_sum above to obtain the actual mean aggregate value.\nThe only possible value type is Long."
+ },
+ "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"
+ }
+ },
+ "id": "MetricUpdate"
},
"ApproximateProgress": {
"type": "object",
"properties": {
"position": {
- "$ref": "Position",
- "description": "Obsolete."
+ "description": "Obsolete.",
+ "$ref": "Position"
},
"percentComplete": {
"description": "Obsolete.",
@@ -3857,31 +4535,27 @@
"description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest."
},
"WorkerMessageResponse": {
+ "description": "A worker_message response allows the server to pass information to the\nsender.",
"type": "object",
"properties": {
"workerMetricsResponse": {
- "$ref": "ResourceUtilizationReportResponse",
- "description": "Service's response to reporting worker metrics (currently empty)."
+ "description": "Service's response to reporting worker metrics (currently empty).",
+ "$ref": "ResourceUtilizationReportResponse"
},
"workerHealthReportResponse": {
- "description": "The service's response to a worker's health report.",
- "$ref": "WorkerHealthReportResponse"
+ "$ref": "WorkerHealthReportResponse",
+ "description": "The service's response to a worker's health report."
}
},
- "id": "WorkerMessageResponse",
- "description": "A worker_message response allows the server to pass information to the\nsender."
+ "id": "WorkerMessageResponse"
},
"TemplateMetadata": {
"description": "Metadata describing a template.",
"type": "object",
"properties": {
- "bypassTempDirValidation": {
- "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"
+ "type": "string",
+ "description": "Required. The name of the template."
},
"parameters": {
"description": "The parameters for the template.",
@@ -3901,6 +4575,15 @@
"description": "WorkerMessage provides information to the backend about a worker.",
"type": "object",
"properties": {
+ "time": {
+ "description": "The timestamp of the worker_message.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "workerHealthReport": {
+ "$ref": "WorkerHealthReport",
+ "description": "The health of a worker."
+ },
"workerMessageCode": {
"$ref": "WorkerMessageCode",
"description": "A worker message code."
@@ -3910,20 +4593,11 @@
"description": "Resource metrics reported by workers."
},
"labels": {
- "description": "Labels are used to group WorkerMessages.\nFor example, a worker_message about a particular container\nmight have the labels:\n{ \"JOB_ID\": \"2015-04-22\",\n \"WORKER_ID\": \"wordcount-vm-2015…\"\n \"CONTAINER_TYPE\": \"worker\",\n \"CONTAINER_ID\": \"ac1234def\"}\nLabel tags typically correspond to Label enum values. However, for ease\nof development other strings can be used as tags. LABEL_UNSPECIFIED should\nnot be used here.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
- },
- "time": {
- "description": "The timestamp of the worker_message.",
- "format": "google-datetime",
- "type": "string"
- },
- "workerHealthReport": {
- "description": "The health of a worker.",
- "$ref": "WorkerHealthReport"
+ },
+ "description": "Labels are used to group WorkerMessages.\nFor example, a worker_message about a particular container\nmight have the labels:\n{ \"JOB_ID\": \"2015-04-22\",\n \"WORKER_ID\": \"wordcount-vm-2015…\"\n \"CONTAINER_TYPE\": \"worker\",\n \"CONTAINER_ID\": \"ac1234def\"}\nLabel tags typically correspond to Label enum values. However, for ease\nof development other strings can be used as tags. LABEL_UNSPECIFIED should\nnot be used here.",
+ "type": "object"
}
},
"id": "WorkerMessage"
@@ -3948,6 +4622,7 @@
"type": "object"
},
"FloatingPointList": {
+ "type": "object",
"properties": {
"elements": {
"description": "Elements of the list.",
@@ -3959,20 +4634,24 @@
}
},
"id": "FloatingPointList",
- "description": "A metric value representing a list of floating point numbers.",
- "type": "object"
+ "description": "A metric value representing a list of floating point numbers."
},
"CounterUpdate": {
+ "description": "An update to a Counter sent from a worker.",
"type": "object",
"properties": {
- "structuredNameAndMetadata": {
- "$ref": "CounterStructuredNameAndMetadata",
- "description": "Counter structured name and metadata."
+ "integer": {
+ "description": "Integer value for Sum, Max, Min.",
+ "$ref": "SplitInt64"
},
"integerList": {
"$ref": "IntegerList",
"description": "List of integers, for Set."
},
+ "structuredNameAndMetadata": {
+ "description": "Counter structured name and metadata.",
+ "$ref": "CounterStructuredNameAndMetadata"
+ },
"integerMean": {
"$ref": "IntegerMean",
"description": "Integer mean aggregation value for Mean."
@@ -3983,8 +4662,8 @@
"type": "number"
},
"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"
+ "type": "boolean",
+ "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."
},
"internal": {
"description": "Value for internally-defined counters used by the Dataflow service.",
@@ -4007,27 +4686,23 @@
"$ref": "StringList"
},
"distribution": {
- "$ref": "DistributionUpdate",
- "description": "Distribution data"
+ "description": "Distribution data",
+ "$ref": "DistributionUpdate"
},
"shortId": {
- "type": "string",
"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"
+ "format": "int64",
+ "type": "string"
},
"floatingPointList": {
"$ref": "FloatingPointList",
"description": "List of floating point numbers, for Set."
- },
- "integer": {
- "$ref": "SplitInt64",
- "description": "Integer value for Sum, Max, Min."
}
},
- "id": "CounterUpdate",
- "description": "An update to a Counter sent from a worker."
+ "id": "CounterUpdate"
},
"SourceMetadata": {
+ "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.",
"type": "object",
"properties": {
"producesSortedKeys": {
@@ -4044,14 +4719,16 @@
"type": "string"
}
},
- "id": "SourceMetadata",
- "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc."
+ "id": "SourceMetadata"
},
"DistributionUpdate": {
- "id": "DistributionUpdate",
"description": "A metric value representing a distribution.",
"type": "object",
"properties": {
+ "sum": {
+ "$ref": "SplitInt64",
+ "description": "Use an int64 since we'd prefer the added precision. If overflow is a common\nproblem we can detect it and use an additional int64 or a double."
+ },
"max": {
"$ref": "SplitInt64",
"description": "The maximum value present in the distribution."
@@ -4068,23 +4745,41 @@
"description": "The count of the number of elements present in the distribution."
},
"min": {
- "$ref": "SplitInt64",
- "description": "The minimum value present in the distribution."
+ "description": "The minimum value present in the distribution.",
+ "$ref": "SplitInt64"
},
"sumOfSquares": {
"description": "Use a double since the sum of squares is likely to overflow int64.",
"format": "double",
"type": "number"
- },
- "sum": {
- "description": "Use an int64 since we'd prefer the added precision. If overflow is a common\nproblem we can detect it and use an additional int64 or a double.",
- "$ref": "SplitInt64"
}
- }
+ },
+ "id": "DistributionUpdate"
+ },
+ "SourceFork": {
+ "type": "object",
+ "properties": {
+ "residualSource": {
+ "$ref": "DerivedSource",
+ "description": "DEPRECATED"
+ },
+ "primary": {
+ "$ref": "SourceSplitShard",
+ "description": "DEPRECATED"
+ },
+ "primarySource": {
+ "description": "DEPRECATED",
+ "$ref": "DerivedSource"
+ },
+ "residual": {
+ "$ref": "SourceSplitShard",
+ "description": "DEPRECATED"
+ }
+ },
+ "id": "SourceFork",
+ "description": "DEPRECATED in favor of DynamicSourceSplit."
},
"WorkerHealthReportResponse": {
- "description": "WorkerHealthReportResponse contains information returned to the worker\nin response to a health ping.",
- "type": "object",
"properties": {
"reportInterval": {
"description": "A positive value indicates the worker should change its reporting interval\nto the specified value.\n\nThe default value of zero means no change in report rate is requested by\nthe server.",
@@ -4092,41 +4787,36 @@
"type": "string"
}
},
- "id": "WorkerHealthReportResponse"
- },
- "SourceFork": {
- "description": "DEPRECATED in favor of DynamicSourceSplit.",
- "type": "object",
- "properties": {
- "residual": {
- "$ref": "SourceSplitShard",
- "description": "DEPRECATED"
- },
- "residualSource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- },
- "primary": {
- "description": "DEPRECATED",
- "$ref": "SourceSplitShard"
- },
- "primarySource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- }
- },
- "id": "SourceFork"
+ "id": "WorkerHealthReportResponse",
+ "description": "WorkerHealthReportResponse contains information returned to the worker\nin response to a health ping.",
+ "type": "object"
},
"WorkItemStatus": {
"description": "Conveys a worker's progress through the work described by a WorkItem.",
"type": "object",
"properties": {
+ "stopPosition": {
+ "$ref": "Position",
+ "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc."
+ },
+ "completed": {
+ "description": "True if the WorkItem was completed (successfully or unsuccessfully).",
+ "type": "boolean"
+ },
+ "reportedProgress": {
+ "description": "The worker's progress through this WorkItem.",
+ "$ref": "ApproximateReportedProgress"
+ },
+ "sourceFork": {
+ "description": "DEPRECATED in favor of dynamic_source_split.",
+ "$ref": "SourceFork"
+ },
"counterUpdates": {
- "description": "Worker output counters for this WorkItem.",
"type": "array",
"items": {
"$ref": "CounterUpdate"
- }
+ },
+ "description": "Worker output counters for this WorkItem."
},
"workItemId": {
"description": "Identifies the WorkItem.",
@@ -4155,8 +4845,8 @@
"description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation."
},
"progress": {
- "description": "DEPRECATED in favor of reported_progress.",
- "$ref": "ApproximateProgress"
+ "$ref": "ApproximateProgress",
+ "description": "DEPRECATED in favor of reported_progress."
},
"requestedLeaseDuration": {
"description": "Amount of time the worker requests for its lease.",
@@ -4167,27 +4857,12 @@
"description": "The report index. When a WorkItem is leased, the lease will\ncontain an initial report index. When a WorkItem's status is\nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service.\n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times before getting back a response. The worker\nshould not submit a subsequent report until the response for the\nprevious report had been received from the service.",
"format": "int64",
"type": "string"
- },
- "stopPosition": {
- "$ref": "Position",
- "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc."
- },
- "completed": {
- "description": "True if the WorkItem was completed (successfully or unsuccessfully).",
- "type": "boolean"
- },
- "reportedProgress": {
- "$ref": "ApproximateReportedProgress",
- "description": "The worker's progress through this WorkItem."
- },
- "sourceFork": {
- "$ref": "SourceFork",
- "description": "DEPRECATED in favor of dynamic_source_split."
}
},
"id": "WorkItemStatus"
},
"ComponentSource": {
+ "id": "ComponentSource",
"description": "Description of an interstitial value between transforms in an execution\nstage.",
"type": "object",
"properties": {
@@ -4203,14 +4878,24 @@
"description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
"type": "string"
}
- },
- "id": "ComponentSource"
+ }
},
"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"
+ },
"splitRequest": {
- "$ref": "ApproximateSplitRequest",
- "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task."
+ "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task.",
+ "$ref": "ApproximateSplitRequest"
},
"suggestedStopPosition": {
"$ref": "Position",
@@ -4240,701 +4925,16 @@
"items": {
"$ref": "MetricShortId"
}
- },
- "nextReportIndex": {
- "type": "string",
- "description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.",
- "format": "int64"
- },
- "suggestedStopPoint": {
- "description": "DEPRECATED in favor of split_request.",
- "$ref": "ApproximateProgress"
}
},
- "id": "WorkItemServiceState",
- "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
- "type": "object"
- },
- "MetricStructuredName": {
- "description": "Identifies a metric, by describing the source which generated the\nmetric.",
- "type": "object",
- "properties": {
- "context": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e.",
- "type": "object"
- },
- "origin": {
- "description": "Origin (namespace) of metric name. May be blank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Dataflow service or SDK.",
- "type": "string"
- },
- "name": {
- "description": "Worker-defined metric name.",
- "type": "string"
- }
- },
- "id": "MetricStructuredName"
- },
- "SeqMapTaskOutputInfo": {
- "id": "SeqMapTaskOutputInfo",
- "description": "Information about an output of a SeqMapTask.",
- "type": "object",
- "properties": {
- "sink": {
- "$ref": "Sink",
- "description": "The sink to write the output value to."
- },
- "tag": {
- "description": "The id of the TupleTag the user code will tag the output value by.",
- "type": "string"
- }
- }
- },
- "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"
- }
- }
- },
- "id": "JobExecutionStageInfo"
- },
- "KeyRangeLocation": {
- "properties": {
- "deprecatedPersistentDirectory": {
- "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem.",
- "type": "string"
- },
- "deliveryEndpoint": {
- "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.",
- "type": "string"
- },
- "start": {
- "description": "The start (inclusive) of the key range.",
- "type": "string"
- },
- "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"
- },
- "end": {
- "description": "The end (exclusive) of the key range.",
- "type": "string"
- }
- },
- "id": "KeyRangeLocation",
- "description": "Location information for a specific key-range of a sharded computation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.",
- "type": "object"
- },
- "SourceGetMetadataRequest": {
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Specification of the source whose metadata should be computed."
- }
- },
- "id": "SourceGetMetadataRequest",
- "description": "A request to compute the SourceMetadata of a Source.",
- "type": "object"
- },
- "NameAndKind": {
- "description": "Basic metadata about a counter.",
- "type": "object",
- "properties": {
- "kind": {
- "description": "Counter aggregation kind.",
- "type": "string",
- "enumDescriptions": [
- "Counter aggregation kind was not set.",
- "Aggregated value is the sum of all contributed values.",
- "Aggregated value is the max of all contributed values.",
- "Aggregated value is the min of all contributed values.",
- "Aggregated value is the mean of all contributed values.",
- "Aggregated value represents the logical 'or' of all contributed values.",
- "Aggregated value represents the logical 'and' of all contributed values.",
- "Aggregated value is a set of unique contributed values.",
- "Aggregated value captures statistics about a distribution."
- ],
- "enum": [
- "INVALID",
- "SUM",
- "MAX",
- "MIN",
- "MEAN",
- "OR",
- "AND",
- "SET",
- "DISTRIBUTION"
- ]
- },
- "name": {
- "description": "Name of the counter.",
- "type": "string"
- }
- },
- "id": "NameAndKind"
- },
- "SeqMapTask": {
- "type": "object",
- "properties": {
- "stageName": {
- "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
- "type": "string"
- },
- "systemName": {
- "description": "System-defined name of the SeqDo operation.\nUnique across the workflow.",
- "type": "string"
- },
- "userFn": {
- "description": "The user function to invoke.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "name": {
- "description": "The user-provided name of the SeqDo operation.",
- "type": "string"
- },
- "outputInfos": {
- "description": "Information about each of the outputs.",
- "type": "array",
- "items": {
- "$ref": "SeqMapTaskOutputInfo"
- }
- },
- "inputs": {
- "description": "Information about each of the inputs.",
- "type": "array",
- "items": {
- "$ref": "SideInputInfo"
- }
- }
- },
- "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": {
- "code": {
- "description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.",
- "type": "string"
- },
- "parameters": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages.",
- "type": "object"
- }
- },
- "id": "WorkerMessageCode"
- },
- "CustomSourceLocation": {
- "type": "object",
- "properties": {
- "stateful": {
- "description": "Whether this source is stateful.",
- "type": "boolean"
- }
- },
- "id": "CustomSourceLocation",
- "description": "Identifies the location of a custom souce."
- },
- "MapTask": {
- "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.",
- "type": "object",
- "properties": {
- "systemName": {
- "description": "System-defined name of this MapTask.\nUnique across the workflow.",
- "type": "string"
- },
- "stageName": {
- "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.",
- "type": "string"
- },
- "instructions": {
- "description": "The instructions in the MapTask.",
- "type": "array",
- "items": {
- "$ref": "ParallelInstruction"
- }
- }
- },
- "id": "MapTask"
- },
- "FloatingPointMean": {
- "properties": {
- "sum": {
- "description": "The sum of all values being aggregated.",
- "format": "double",
- "type": "number"
- },
- "count": {
- "description": "The number of values being aggregated.",
- "$ref": "SplitInt64"
- }
- },
- "id": "FloatingPointMean",
- "description": "A representation of a floating point mean metric contribution.",
- "type": "object"
- },
- "ReportWorkItemStatusResponse": {
- "description": "Response from a request to report the status of WorkItems.",
- "type": "object",
- "properties": {
- "workItemServiceStates": {
- "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.",
- "type": "array",
- "items": {
- "$ref": "WorkItemServiceState"
- }
- }
- },
- "id": "ReportWorkItemStatusResponse"
- },
- "InstructionOutput": {
- "description": "An output of an instruction.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The user-provided name of this output.",
- "type": "string"
- },
- "originalName": {
- "type": "string",
- "description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this."
- },
- "systemName": {
- "description": "System-defined name of this output.\nUnique across the workflow.",
- "type": "string"
- },
- "onlyCountKeyBytes": {
- "type": "boolean",
- "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"
- },
- "codec": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "The codec to use to encode data being written via this output.",
- "type": "object"
- }
- },
- "id": "InstructionOutput"
- },
- "CreateJobFromTemplateRequest": {
- "type": "object",
- "properties": {
- "environment": {
- "$ref": "RuntimeEnvironment",
- "description": "The runtime environment for the job."
- },
- "location": {
- "description": "The location to which to direct the request.",
- "type": "string"
- },
- "parameters": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The runtime parameters to pass to the job.",
- "type": "object"
- },
- "jobName": {
- "description": "Required. The job name to use for the created job.",
- "type": "string"
- },
- "gcsPath": {
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
- "type": "string"
- }
- },
- "id": "CreateJobFromTemplateRequest",
- "description": "A request to create a Cloud Dataflow job from a template."
- },
- "IntegerMean": {
- "description": "A representation of an integer mean metric contribution.",
- "type": "object",
- "properties": {
- "count": {
- "$ref": "SplitInt64",
- "description": "The number of values being aggregated."
- },
- "sum": {
- "description": "The sum of all values being aggregated.",
- "$ref": "SplitInt64"
- }
- },
- "id": "IntegerMean"
- },
- "ListJobsResponse": {
- "description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Set if there may be more results than fit in this response.",
- "type": "string"
- },
- "failedLocation": {
- "type": "array",
- "items": {
- "$ref": "FailedLocation"
- },
- "description": "Zero or more messages describing locations that failed to respond."
- },
- "jobs": {
- "description": "A subset of the requested job information.",
- "type": "array",
- "items": {
- "$ref": "Job"
- }
- }
- },
- "id": "ListJobsResponse"
- },
- "ComputationTopology": {
- "description": "All configuration data for a particular Computation.",
- "type": "object",
- "properties": {
- "userStageName": {
- "description": "The user stage name.",
- "type": "string"
- },
- "outputs": {
- "description": "The outputs from the computation.",
- "type": "array",
- "items": {
- "$ref": "StreamLocation"
- }
- },
- "stateFamilies": {
- "description": "The state family values.",
- "type": "array",
- "items": {
- "$ref": "StateFamilyConfig"
- }
- },
- "systemStageName": {
- "description": "The system stage name.",
- "type": "string"
- },
- "computationId": {
- "description": "The ID of the computation.",
- "type": "string"
- },
- "inputs": {
- "description": "The inputs to the computation.",
- "type": "array",
- "items": {
- "$ref": "StreamLocation"
- }
- },
- "keyRanges": {
- "description": "The key ranges processed by the computation.",
- "type": "array",
- "items": {
- "$ref": "KeyRangeLocation"
- }
- }
- },
- "id": "ComputationTopology"
- },
- "RuntimeEnvironment": {
- "description": "The environment values to set at runtime.",
- "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"
- },
- "MountedDataDisk": {
- "id": "MountedDataDisk",
- "description": "Describes mounted data disk.",
- "type": "object",
- "properties": {
- "dataDisk": {
- "type": "string",
- "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\"."
- }
- }
- },
- "StreamingSideInputLocation": {
- "properties": {
- "stateFamily": {
- "description": "Identifies the state family where this side input is stored.",
- "type": "string"
- },
- "tag": {
- "description": "Identifies the particular side input within the streaming Dataflow job.",
- "type": "string"
- }
- },
- "id": "StreamingSideInputLocation",
- "description": "Identifies the location of a streaming side input.",
- "type": "object"
- },
- "LaunchTemplateResponse": {
- "properties": {
- "job": {
- "$ref": "Job",
- "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched."
- }
- },
- "id": "LaunchTemplateResponse",
- "description": "Response to the request to launch a template.",
- "type": "object"
- },
- "Job": {
- "description": "Defines a job to be run by the Cloud Dataflow service.",
- "type": "object",
- "properties": {
- "currentStateTime": {
- "description": "The timestamp associated with the current state.",
- "format": "google-datetime",
- "type": "string"
- },
- "transformNameMapping": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
- "type": "object"
- },
- "createTime": {
- "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
- "format": "google-datetime",
- "type": "string"
- },
- "environment": {
- "description": "The environment for the job.",
- "$ref": "Environment"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "User-defined labels for this job.\n\nThe labels map can contain no more than 64 entries. Entries of the labels\nmap are UTF8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be \u003c= 128 bytes in\nsize.",
- "type": "object"
- },
- "stageStates": {
- "type": "array",
- "items": {
- "$ref": "ExecutionStageState"
- },
- "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it."
- },
- "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"
- },
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string"
- },
- "pipelineDescription": {
- "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.",
- "$ref": "PipelineDescription"
- },
- "replaceJobId": {
- "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job.",
- "type": "string"
- },
- "requestedState": {
- "type": "string",
- "enumDescriptions": [
- "The job's run state isn't specified.",
- "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
- "`JOB_STATE_RUNNING` indicates that the job is currently running.",
- "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
- "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
- "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
- "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
- "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
- "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
- "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
- "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
- ],
- "enum": [
- "JOB_STATE_UNKNOWN",
- "JOB_STATE_STOPPED",
- "JOB_STATE_RUNNING",
- "JOB_STATE_DONE",
- "JOB_STATE_FAILED",
- "JOB_STATE_CANCELLED",
- "JOB_STATE_UPDATED",
- "JOB_STATE_DRAINING",
- "JOB_STATE_DRAINED",
- "JOB_STATE_PENDING",
- "JOB_STATE_CANCELLING"
- ],
- "description": "The job's requested state.\n\n`UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the\njob if it has not already reached a terminal state."
- },
- "tempFiles": {
- "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "clientRequestId": {
- "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
- "type": "string"
- },
- "name": {
- "description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`",
- "type": "string"
- },
- "replacedByJobId": {
- "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
- "type": "string"
- },
- "steps": {
- "description": "The top-level steps that constitute the entire job.",
- "type": "array",
- "items": {
- "$ref": "Step"
- }
- },
- "id": {
- "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.",
- "type": "string"
- },
- "executionInfo": {
- "description": "Deprecated.",
- "$ref": "JobExecutionInfo"
- },
- "currentState": {
- "enumDescriptions": [
- "The job's run state isn't specified.",
- "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
- "`JOB_STATE_RUNNING` indicates that the job is currently running.",
- "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
- "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
- "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
- "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
- "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
- "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
- "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
- "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
- ],
- "enum": [
- "JOB_STATE_UNKNOWN",
- "JOB_STATE_STOPPED",
- "JOB_STATE_RUNNING",
- "JOB_STATE_DONE",
- "JOB_STATE_FAILED",
- "JOB_STATE_CANCELLED",
- "JOB_STATE_UPDATED",
- "JOB_STATE_DRAINING",
- "JOB_STATE_DRAINED",
- "JOB_STATE_PENDING",
- "JOB_STATE_CANCELLING"
- ],
- "description": "The 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"
- },
- "location": {
- "description": "The location that contains this job.",
- "type": "string"
- }
- },
- "id": "Job"
- },
- "DynamicSourceSplit": {
- "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input.",
- "type": "object",
- "properties": {
- "primary": {
- "$ref": "DerivedSource",
- "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current."
- },
- "residual": {
- "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source.",
- "$ref": "DerivedSource"
- }
- },
- "id": "DynamicSourceSplit"
- },
- "DerivedSource": {
- "type": "object",
- "properties": {
- "derivationMode": {
- "description": "What source to base the produced source on (if any).",
- "type": "string",
- "enumDescriptions": [
- "The source derivation is unknown, or unspecified.",
- "Produce a completely independent Source with no base.",
- "Produce a Source based on the Source being split.",
- "Produce a Source based on the base of the Source being split."
- ],
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ]
- },
- "source": {
- "$ref": "Source",
- "description": "Specification of the 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."
+ "id": "WorkItemServiceState"
}
},
+ "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": "v1b3",
"baseUrl": "https://dataflow.googleapis.com/",
"auth": {
@@ -4954,9 +4954,5 @@
},
"kind": "discovery#restDescription",
"description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.",
- "servicePath": "",
- "rootUrl": "https://dataflow.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "dataflow"
+ "servicePath": ""
}
diff --git a/dataflow/v1b3/dataflow-gen.go b/dataflow/v1b3/dataflow-gen.go
index 87f7d82..340a833 100644
--- a/dataflow/v1b3/dataflow-gen.go
+++ b/dataflow/v1b3/dataflow-gen.go
@@ -685,9 +685,6 @@
// SystemStageName: The system stage name.
SystemStageName string `json:"systemStageName,omitempty"`
- // UserStageName: The user stage name.
- UserStageName string `json:"userStageName,omitempty"`
-
// ForceSendFields is a list of field names (e.g. "ComputationId") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -3904,6 +3901,11 @@
// Use with caution.
BypassTempDirValidation bool `json:"bypassTempDirValidation,omitempty"`
+ // MachineType: The machine type to use for the job. Defaults to the
+ // value from the
+ // template if not specified.
+ MachineType string `json:"machineType,omitempty"`
+
// MaxWorkers: The maximum number of Google Compute Engine instances to
// be made
// available to your pipeline during execution, from 1 to 1000.
@@ -3917,9 +3919,10 @@
// Must be a valid Cloud Storage URL, beginning with `gs://`.
TempLocation string `json:"tempLocation,omitempty"`
- // Zone: The Compute Engine [availability
- // zone](https://cloud.google.com/compute/docs/regions-zones/regions-zone
- // s)
+ // Zone: The Compute Engine
+ // [availability
+ // zone](https://cloud.google.com/compute/docs/regions-zone
+ // s/regions-zones)
// for launching worker instances to run your pipeline.
Zone string `json:"zone,omitempty"`
@@ -4851,7 +4854,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -4884,7 +4887,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
@@ -5521,13 +5524,6 @@
// TemplateMetadata: Metadata describing a template.
type TemplateMetadata struct {
- // BypassTempDirValidation: If true, will bypass the validation that the
- // temp directory is
- // writable. This should only be used with templates for pipelines
- // that are guaranteed not to need to write to the temp directory,
- // which is subject to change based on the optimizer.
- BypassTempDirValidation bool `json:"bypassTempDirValidation,omitempty"`
-
// Description: Optional. A description of the template.
Description string `json:"description,omitempty"`
@@ -5537,22 +5533,20 @@
// Parameters: The parameters for the template.
Parameters []*ParameterMetadata `json:"parameters,omitempty"`
- // ForceSendFields is a list of field names (e.g.
- // "BypassTempDirValidation") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
- // 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 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. "BypassTempDirValidation")
- // to include in API requests with the JSON null value. By default,
- // fields with empty values are omitted from API requests. However, any
- // field with an empty value appearing in NullFields will be sent to the
- // 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. "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:"-"`
}
diff --git a/dataproc/v1/dataproc-api.json b/dataproc/v1/dataproc-api.json
index 0eb3246..e07aca4 100644
--- a/dataproc/v1/dataproc-api.json
+++ b/dataproc/v1/dataproc-api.json
@@ -1,11 +1,8 @@
{
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "dataproc",
"batchPath": "batch",
- "documentationLink": "https://cloud.google.com/dataproc/",
- "revision": "20170502",
+ "revision": "20170523",
"id": "dataproc:v1",
+ "documentationLink": "https://cloud.google.com/dataproc/",
"title": "Google Cloud Dataproc API",
"discoveryVersion": "v1",
"ownerName": "Google",
@@ -14,69 +11,306 @@
"resources": {
"regions": {
"resources": {
- "operations": {
+ "clusters": {
"methods": {
- "cancel": {
- "id": "dataproc.projects.regions.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. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
- "httpMethod": "POST",
+ "diagnose": {
"response": {
- "$ref": "Empty"
+ "$ref": "Operation"
},
"parameterOrder": [
- "name"
+ "projectId",
+ "region",
+ "clusterName"
],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "name": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path"
+ },
+ "clusterName": {
"location": "path",
- "description": "The name of the operation resource to be cancelled."
+ "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": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel"
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "id": "dataproc.projects.regions.clusters.diagnose",
+ "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
+ "request": {
+ "$ref": "DiagnoseClusterRequest"
+ }
},
"delete": {
+ "description": "Deletes a cluster in a project.",
"httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.delete",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. The standard List page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The standard List page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.list",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters",
+ "description": "Lists all regions/{region}/clusters in a project."
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "POST",
+ "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": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.create",
+ "description": "Creates a cluster in a project.",
+ "request": {
+ "$ref": "Cluster"
+ }
+ },
+ "get": {
+ "description": "Gets the resource representation for a cluster in a project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Cluster"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ },
+ "patch": {
+ "description": "Updates a cluster in a project.",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "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": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, only the following fields can be updated:\u003ctable\u003e \u003ctbody\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003eMask\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003e\u003cstrong\u003ePurpose\u003c/strong\u003e\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003elabels\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eUpdate labels\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize primary worker group\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.secondary_worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize secondary worker group\u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e \u003c/table\u003e",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.patch",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "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": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path",
"description": "The name of the operation resource to be deleted.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "id": "dataproc.projects.regions.operations.delete",
"path": "v1/{+name}",
- "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED."
+ "id": "dataproc.projects.regions.operations.delete"
},
"list": {
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "name": {
- "description": "The name of the operation collection.",
- "required": true,
+ "filter": {
+ "description": "The standard list filter.",
"type": "string",
+ "location": "query"
+ },
+ "name": {
"pattern": "^projects/[^/]+/regions/[^/]+/operations$",
- "location": "path"
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string"
},
"pageToken": {
"location": "query",
@@ -88,26 +322,14 @@
"description": "The standard list page size.",
"format": "int32",
"type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
"path": "v1/{+name}",
- "id": "dataproc.projects.regions.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding 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"
+ "id": "dataproc.projects.regions.operations.list"
},
"get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"response": {
"$ref": "Operation"
},
@@ -129,14 +351,39 @@
},
"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."
+ "id": "dataproc.projects.regions.operations.get"
+ },
+ "cancel": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
+ "id": "dataproc.projects.regions.operations.cancel",
+ "path": "v1/{+name}:cancel",
+ "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."
}
}
},
"jobs": {
"methods": {
- "cancel": {
+ "get": {
+ "description": "Gets the resource representation for a job in a project.",
"response": {
"$ref": "Job"
},
@@ -145,22 +392,19 @@
"region",
"jobId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "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"
+ "type": "string",
+ "location": "path"
},
"jobId": {
- "location": "path",
"description": "Required. The job ID.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"region": {
"location": "path",
@@ -169,53 +413,18 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.regions.jobs.cancel",
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
- "request": {
- "$ref": "CancelJobRequest"
- }
- },
- "get": {
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to."
- },
- "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"
],
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.get",
"path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "description": "Gets the resource representation for a job in a project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ]
+ "id": "dataproc.projects.regions.jobs.get"
},
"patch": {
+ "description": "Updates a job in a project.",
+ "request": {
+ "$ref": "Job"
+ },
"httpMethod": "PATCH",
"parameterOrder": [
"projectId",
@@ -225,19 +434,10 @@
"response": {
"$ref": "Job"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
@@ -245,28 +445,36 @@
"location": "path"
},
"jobId": {
+ "location": "path",
"description": "Required. The job ID.",
"required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
"type": "string",
"location": "path"
+ },
+ "updateMask": {
+ "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}",
"id": "dataproc.projects.regions.jobs.patch",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "request": {
- "$ref": "Job"
- },
- "description": "Updates a job in a project."
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
},
"submit": {
- "description": "Submits a job to a cluster.",
+ "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.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -275,15 +483,12 @@
"response": {
"$ref": "Job"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"region": {
+ "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
@@ -292,23 +497,23 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit",
- "path": "v1/projects/{projectId}/regions/{region}/jobs:submit"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"delete": {
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.delete",
+ "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
+ "response": {
+ "$ref": "Empty"
+ },
"httpMethod": "DELETE",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
- "response": {
- "$ref": "Empty"
- },
- "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.",
@@ -317,29 +522,24 @@
"location": "path"
},
"jobId": {
- "location": "path",
"description": "Required. The job ID.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"region": {
- "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.delete",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
},
"list": {
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs",
- "id": "dataproc.projects.regions.jobs.list",
- "path": "v1/projects/{projectId}/regions/{region}/jobs",
- "description": "Lists regions/{region}/jobs in a project.",
- "httpMethod": "GET",
"response": {
"$ref": "ListJobsResponse"
},
@@ -347,14 +547,15 @@
"projectId",
"region"
],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
- "type": "string",
"location": "query",
- "description": "Optional. The page token, returned by a previous call, to request the next page of results."
+ "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -363,15 +564,15 @@
"type": "integer"
},
"region": {
- "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"clusterName": {
+ "location": "query",
"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": {
"location": "path",
@@ -394,106 +595,29 @@
"description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
"type": "string"
}
- }
- }
- }
- },
- "clusters": {
- "methods": {
- "diagnose": {
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs",
+ "id": "dataproc.projects.regions.jobs.list",
+ "description": "Lists regions/{region}/jobs in a project."
+ },
+ "cancel": {
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "id": "dataproc.projects.regions.jobs.cancel",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "request": {
+ "$ref": "CancelJobRequest"
+ },
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
"region",
- "clusterName"
+ "jobId"
],
"response": {
- "$ref": "Operation"
+ "$ref": "Job"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "id": "dataproc.projects.regions.clusters.diagnose",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
- "request": {
- "$ref": "DiagnoseClusterRequest"
- }
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.delete",
- "description": "Deletes a cluster in a project."
- },
- "list": {
- "id": "dataproc.projects.regions.clusters.list",
- "path": "v1/projects/{projectId}/regions/{region}/clusters",
- "description": "Lists all regions/{region}/clusters in a project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "response": {
- "$ref": "ListClustersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"region": {
"location": "path",
@@ -501,149 +625,22 @@
"required": true,
"type": "string"
},
- "filter": {
- "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "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"
- },
"projectId": {
"location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
"type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters"
- },
- "create": {
- "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "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"
},
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "jobId": {
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "Required. The job ID."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
- },
- "get": {
- "description": "Gets 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 Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "clusterName": {
- "location": "path",
- "description": "Required. The cluster name.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
- },
- "patch": {
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch",
- "description": "Updates 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": {
- "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"
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, only the following fields can be updated:\u003ctable\u003e \u003ctbody\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003eMask\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003e\u003cstrong\u003ePurpose\u003c/strong\u003e\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003elabels\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eUpdate labels\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize primary worker group\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.secondary_worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize secondary worker group\u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e \u003c/table\u003e",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
}
}
}
@@ -653,15 +650,21 @@
}
},
"parameters": {
+ "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",
- "location": "query"
+ "type": "string"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"callback": {
"description": "JSONP",
@@ -669,19 +672,25 @@
"location": "query"
},
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
},
"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": [
@@ -689,17 +698,6 @@
"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": {
@@ -707,10 +705,15 @@
"description": "OAuth access token.",
"type": "string"
},
- "quotaUser": {
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ "description": "Available to use 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.",
@@ -719,875 +722,24 @@
"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\").",
+ "description": "OAuth bearer token.",
"type": "string"
},
- "prettyPrint": {
+ "oauth_token": {
"location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
+ "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"
}
},
"schemas": {
- "JobPlacement": {
- "description": "Cloud Dataproc job config.",
- "type": "object",
- "properties": {
- "clusterName": {
- "description": "Required. The name of the cluster where the job will be submitted.",
- "type": "string"
- },
- "clusterUuid": {
- "description": "Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.",
- "type": "string"
- }
- },
- "id": "JobPlacement"
- },
- "SoftwareConfig": {
- "description": "Specifies the selection and config of software inside the cluster.",
- "type": "object",
- "properties": {
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xml",
- "type": "object"
- },
- "imageVersion": {
- "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).",
- "type": "string"
- }
- },
- "id": "SoftwareConfig"
- },
- "ClusterStatus": {
- "description": "The status of a cluster and its instances.",
- "type": "object",
- "properties": {
- "detail": {
- "description": "Output-only. Optional details of cluster's state.",
- "type": "string"
- },
- "state": {
- "enum": [
- "UNKNOWN",
- "CREATING",
- "RUNNING",
- "ERROR",
- "DELETING",
- "UPDATING"
- ],
- "description": "Output-only. The cluster's state.",
- "type": "string",
- "enumDescriptions": [
- "The cluster state is unknown.",
- "The cluster is being created and set up. It is not ready for use.",
- "The cluster is currently running and healthy. It is ready for use.",
- "The cluster encountered an error. It is not ready for use.",
- "The cluster is being deleted. It cannot be used.",
- "The cluster is being updated. It continues to accept and process jobs."
- ]
- },
- "stateStartTime": {
- "description": "Output-only. Time when this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
- "substate": {
- "description": "Output-only. Additional state information that includes status reported by the agent.",
- "type": "string",
- "enumDescriptions": [
- "",
- "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.",
- "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
- ],
- "enum": [
- "UNSPECIFIED",
- "UNHEALTHY",
- "STALE_STATUS"
- ]
- }
- },
- "id": "ClusterStatus"
- },
- "PigJob": {
- "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
- "type": "object",
- "properties": {
- "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",
- "items": {
- "type": "string"
- }
- },
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
- "type": "object"
- },
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
- },
- "properties": {
- "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"
- }
- },
- "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"
- }
- },
- "id": "PigJob"
- },
- "ListClustersResponse": {
- "properties": {
- "clusters": {
- "description": "Output-only. The clusters in the project.",
- "type": "array",
- "items": {
- "$ref": "Cluster"
- }
- },
- "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 ListClustersRequest.",
- "type": "string"
- }
- },
- "id": "ListClustersResponse",
- "description": "The list of all clusters in a project.",
- "type": "object"
- },
- "SparkJob": {
- "type": "object",
- "properties": {
- "mainClass": {
- "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file that contains the main class.",
- "type": "string"
- },
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
- },
- "properties": {
- "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "args": {
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "SparkJob",
- "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN."
- },
- "Job": {
- "description": "A Cloud Dataproc job resource.",
- "type": "object",
- "properties": {
- "driverOutputResourceUri": {
- "description": "Output-only. A URI pointing to the location of the stdout of the job's driver program.",
- "type": "string"
- },
- "statusHistory": {
- "description": "Output-only. The previous job status.",
- "type": "array",
- "items": {
- "$ref": "JobStatus"
- }
- },
- "sparkSqlJob": {
- "description": "Job is a SparkSql job.",
- "$ref": "SparkSqlJob"
- },
- "sparkJob": {
- "description": "Job is a Spark job.",
- "$ref": "SparkJob"
- },
- "yarnApplications": {
- "description": "Output-only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "type": "array",
- "items": {
- "$ref": "YarnApplication"
- }
- },
- "pysparkJob": {
- "description": "Job is a Pyspark job.",
- "$ref": "PySparkJob"
- },
- "reference": {
- "$ref": "JobReference",
- "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e."
- },
- "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": {
- "type": "string",
- "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri."
- },
- "scheduling": {
- "description": "Optional. Job scheduling configuration.",
- "$ref": "JobScheduling"
- },
- "pigJob": {
- "description": "Job is a Pig job.",
- "$ref": "PigJob"
- },
- "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 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"
- }
- },
- "id": "Job"
- },
- "JobStatus": {
- "properties": {
- "state": {
- "enumDescriptions": [
- "The job state is unknown.",
- "The job is pending; it has been submitted, but is not yet running.",
- "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.",
- "The job is running on the cluster.",
- "A CancelJob request has been received, but is pending.",
- "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
- "The job cancellation was successful.",
- "The job has completed successfully.",
- "The job has completed, but encountered an error.",
- "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "PENDING",
- "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"
- },
- "details": {
- "description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
- "type": "string"
- },
- "stateStartTime": {
- "description": "Output-only. The time when this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
- "substate": {
- "description": "Output-only. Additional state information, which includes status reported by the agent.",
- "type": "string",
- "enumDescriptions": [
- "",
- "The Job is submitted to the agent.Applies to RUNNING state.",
- "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
- "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
- ],
- "enum": [
- "UNSPECIFIED",
- "SUBMITTED",
- "QUEUED",
- "STALE_STATUS"
- ]
- }
- },
- "id": "JobStatus",
- "description": "Cloud Dataproc job status.",
- "type": "object"
- },
- "ManagedGroupConfig": {
- "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": "ManagedGroupConfig"
- },
- "ClusterOperationStatus": {
- "id": "ClusterOperationStatus",
- "description": "The status of the operation.",
- "type": "object",
- "properties": {
- "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"
- },
- "state": {
- "description": "Output-only. A message containing the operation state.",
- "type": "string",
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ],
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ]
- },
- "details": {
- "description": "Output-only.A message containing any operation metadata details.",
- "type": "string"
- }
- }
- },
- "HadoopJob": {
- "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
- "type": "object",
- "properties": {
- "mainClass": {
- "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
- "type": "string"
- },
- "jarFileUris": {
- "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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": {
- "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"
- }
- }
- },
- "id": "HadoopJob"
- },
- "QueryList": {
- "description": "A list of queries to run on a cluster.",
- "type": "object",
- "properties": {
- "queries": {
- "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "QueryList"
- },
- "YarnApplication": {
- "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Required. The application name.",
- "type": "string"
- },
- "trackingUrl": {
- "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
- "type": "string"
- },
- "progress": {
- "description": "Required. The numerical progress of the application, from 1 to 100.",
- "format": "float",
- "type": "number"
- },
- "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",
- "NEW_SAVING",
- "SUBMITTED",
- "ACCEPTED",
- "RUNNING",
- "FINISHED",
- "FAILED",
- "KILLED"
- ],
- "description": "Required. The application state.",
- "type": "string"
- }
- },
- "id": "YarnApplication"
- },
- "DiagnoseClusterRequest": {
- "description": "A request to collect cluster diagnostic information.",
- "type": "object",
- "properties": {},
- "id": "DiagnoseClusterRequest"
- },
- "DiskConfig": {
- "description": "Specifies the config of disk options for a group of VM instances.",
- "type": "object",
- "properties": {
- "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 (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"
- }
- },
- "id": "DiskConfig"
- },
- "ClusterOperationMetadata": {
- "description": "Metadata describing the operation.",
- "type": "object",
- "properties": {
- "warnings": {
- "description": "Output-only. Errors encountered during operation execution.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Output-only. Labels associated with the operation",
- "type": "object"
- },
- "status": {
- "description": "Output-only. Current operation status.",
- "$ref": "ClusterOperationStatus"
- },
- "statusHistory": {
- "description": "Output-only. The previous operation status.",
- "type": "array",
- "items": {
- "$ref": "ClusterOperationStatus"
- }
- },
- "clusterUuid": {
- "description": "Output-only. Cluster UUID for the operation.",
- "type": "string"
- },
- "clusterName": {
- "description": "Output-only. Name of the cluster for the operation.",
- "type": "string"
- },
- "operationType": {
- "description": "Output-only. The operation type.",
- "type": "string"
- },
- "description": {
- "description": "Output-only. Short description of operation.",
- "type": "string"
- }
- },
- "id": "ClusterOperationMetadata"
- },
- "HiveJob": {
- "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
- "type": "object",
- "properties": {
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains Hive queries.",
- "type": "string"
- },
- "queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
- },
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "scriptVariables": {
- "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "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"
- }
- },
- "id": "HiveJob"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "DiagnoseClusterResults": {
- "description": "The location of diagnostic output.",
- "type": "object",
- "properties": {
- "outputUri": {
- "type": "string",
- "description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics."
- }
- },
- "id": "DiagnoseClusterResults"
- },
- "ClusterConfig": {
- "description": "The cluster config.",
- "type": "object",
- "properties": {
- "softwareConfig": {
- "$ref": "SoftwareConfig",
- "description": "Optional. The config settings for software inside the cluster."
- },
- "masterConfig": {
- "$ref": "InstanceGroupConfig",
- "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster."
- },
- "secondaryWorkerConfig": {
- "$ref": "InstanceGroupConfig",
- "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster."
- },
- "initializationActions": {
- "description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
- "type": "array",
- "items": {
- "$ref": "NodeInitializationAction"
- }
- },
- "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": {
- "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster.",
- "$ref": "InstanceGroupConfig"
- },
- "gceClusterConfig": {
- "$ref": "GceClusterConfig",
- "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster."
- }
- },
- "id": "ClusterConfig"
- },
- "PySparkJob": {
- "properties": {
- "archiveUris": {
- "description": "Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "jarFileUris": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks."
- },
- "loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
- },
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object"
- },
- "args": {
- "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "fileUris": {
- "description": "Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "pythonFileUris": {
- "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainPythonFileUri": {
- "description": "Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.",
- "type": "string"
- }
- },
- "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"
- },
- "GceClusterConfig": {
- "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "internalIpOnly": {
- "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
- "type": "boolean"
- },
- "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"
- },
- "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": "GceClusterConfig"
- },
- "AcceleratorConfig": {
- "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
- "type": "object",
- "properties": {
- "acceleratorCount": {
- "description": "The number of the accelerator cards of this type exposed to this instance.",
- "format": "int32",
- "type": "integer"
- },
- "acceleratorTypeUri": {
- "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"
- },
- "ClusterMetrics": {
- "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "type": "object",
- "properties": {
- "yarnMetrics": {
- "description": "The YARN metrics.",
- "type": "object",
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- }
- },
- "hdfsMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The HDFS metrics.",
- "type": "object"
- }
- },
- "id": "ClusterMetrics"
- },
- "LoggingConfig": {
- "id": "LoggingConfig",
- "description": "The runtime logging config of the job.",
- "type": "object",
- "properties": {
- "driverLogLevels": {
- "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
- "type": "object",
- "additionalProperties": {
- "enum": [
- "LEVEL_UNSPECIFIED",
- "ALL",
- "TRACE",
- "DEBUG",
- "INFO",
- "WARN",
- "ERROR",
- "FATAL",
- "OFF"
- ],
- "type": "string"
- }
- }
- }
- },
- "DiagnoseClusterOutputLocation": {
- "id": "DiagnoseClusterOutputLocation",
- "description": "The location where output from diagnostic command can be found.",
- "type": "object",
- "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"
- }
- }
- },
"Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
"response": {
@@ -1603,8 +755,8 @@
"type": "string"
},
"error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
@@ -1619,8 +771,7 @@
"type": "boolean"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a network API call."
+ "id": "Operation"
},
"OperationStatus": {
"id": "OperationStatus",
@@ -1637,7 +788,6 @@
"type": "string"
},
"state": {
- "type": "string",
"enumDescriptions": [
"Unused.",
"The operation has been created.",
@@ -1650,7 +800,8 @@
"RUNNING",
"DONE"
],
- "description": "A message containing the operation state."
+ "description": "A message containing the operation state.",
+ "type": "string"
},
"details": {
"description": "A message containing any operation metadata details.",
@@ -1659,6 +810,9 @@
}
},
"JobReference": {
+ "id": "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.",
@@ -1668,23 +822,22 @@
"description": "Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
"type": "string"
}
- },
- "id": "JobReference",
- "description": "Encapsulates the full scoping used to reference a job.",
- "type": "object"
+ }
},
"SubmitJobRequest": {
"description": "A request to submit a job.",
"type": "object",
"properties": {
"job": {
- "$ref": "Job",
- "description": "Required. The job resource."
+ "description": "Required. The job resource.",
+ "$ref": "Job"
}
},
"id": "SubmitJobRequest"
},
"Status": {
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
"details": {
"description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.",
@@ -1707,36 +860,48 @@
"type": "string"
}
},
- "id": "Status",
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc 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"
+ "id": "Status"
},
- "InstanceGroupConfig": {
- "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
+ "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": {
- "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."
+ "maxFailuresPerHour": {
+ "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "JobScheduling"
+ },
+ "InstanceGroupConfig": {
+ "properties": {
+ "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"
},
+ "managedGroupConfig": {
+ "description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.",
+ "$ref": "ManagedGroupConfig"
+ },
+ "isPreemptible": {
+ "description": "Optional. Specifies that this instance group contains preemptible instances.",
+ "type": "boolean"
+ },
"imageUri": {
- "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.",
- "type": "string"
+ "type": "string",
+ "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version."
},
"instanceNames": {
- "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name)."
},
"accelerators": {
"description": "Optional. The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.",
@@ -1749,25 +914,11 @@
"description": "Required. The number of VM instances in the instance group. For master instance groups, must be set to 1.",
"format": "int32",
"type": "integer"
- },
- "diskConfig": {
- "$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": {
- "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"
+ "id": "InstanceGroupConfig",
+ "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
+ "type": "object"
},
"NodeInitializationAction": {
"description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
@@ -1779,8 +930,8 @@
"type": "string"
},
"executableFile": {
- "description": "Required. Google Cloud Storage URI of executable file.",
- "type": "string"
+ "type": "string",
+ "description": "Required. Google Cloud Storage URI of executable file."
}
},
"id": "NodeInitializationAction"
@@ -1789,16 +940,16 @@
"description": "A list of jobs in a project.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
- "type": "string"
- },
"jobs": {
"description": "Output-only. Jobs list.",
"type": "array",
"items": {
"$ref": "Job"
}
+ },
+ "nextPageToken": {
+ "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
+ "type": "string"
}
},
"id": "ListJobsResponse"
@@ -1813,14 +964,14 @@
"description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
"type": "object",
"properties": {
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ },
"queryFileUri": {
"description": "The HCFS URI of the script that contains SQL queries.",
"type": "string"
},
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.",
"type": "array",
@@ -1836,8 +987,8 @@
"type": "object"
},
"loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
},
"properties": {
"additionalProperties": {
@@ -1850,10 +1001,13 @@
"id": "SparkSqlJob"
},
"Cluster": {
- "id": "Cluster",
"description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.",
"type": "object",
"properties": {
+ "projectId": {
+ "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
+ "type": "string"
+ },
"labels": {
"additionalProperties": {
"type": "string"
@@ -1866,8 +1020,8 @@
"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."
+ "description": "Output-only. Cluster status.",
+ "$ref": "ClusterStatus"
},
"statusHistory": {
"description": "Output-only. The previous cluster status.",
@@ -1885,37 +1039,76 @@
"type": "string"
},
"clusterUuid": {
- "type": "string",
- "description": "Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster."
- },
- "projectId": {
- "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
+ "description": "Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.",
"type": "string"
}
- }
+ },
+ "id": "Cluster"
},
"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": {
- "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"
+ },
+ "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"
+ ]
+ },
+ "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",
@@ -1944,29 +1137,376 @@
"items": {
"$ref": "OperationStatus"
}
- },
- "operationType": {
- "description": "Output-only The operation type.",
+ }
+ },
+ "id": "OperationMetadata",
+ "description": "Metadata describing the operation.",
+ "type": "object"
+ },
+ "JobPlacement": {
+ "properties": {
+ "clusterName": {
+ "description": "Required. The name of the cluster where the job will be submitted.",
"type": "string"
},
- "description": {
- "description": "Output-only Short description of operation.",
+ "clusterUuid": {
+ "description": "Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.",
"type": "string"
+ }
+ },
+ "id": "JobPlacement",
+ "description": "Cloud Dataproc job config.",
+ "type": "object"
+ },
+ "SoftwareConfig": {
+ "description": "Specifies the selection and config of software inside the cluster.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xml",
+ "type": "object"
+ },
+ "imageVersion": {
+ "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).",
+ "type": "string"
+ }
+ },
+ "id": "SoftwareConfig"
+ },
+ "ClusterStatus": {
+ "description": "The status of a cluster and its instances.",
+ "type": "object",
+ "properties": {
+ "detail": {
+ "description": "Output-only. Optional details of cluster's state.",
+ "type": "string"
+ },
+ "state": {
+ "description": "Output-only. The cluster's state.",
+ "type": "string",
+ "enumDescriptions": [
+ "The cluster state is unknown.",
+ "The cluster is being created and set up. It is not ready for use.",
+ "The cluster is currently running and healthy. It is ready for use.",
+ "The cluster encountered an error. It is not ready for use.",
+ "The cluster is being deleted. It cannot be used.",
+ "The cluster is being updated. It continues to accept and process jobs."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "CREATING",
+ "RUNNING",
+ "ERROR",
+ "DELETING",
+ "UPDATING"
+ ]
+ },
+ "stateStartTime": {
+ "description": "Output-only. Time when this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "substate": {
+ "enumDescriptions": [
+ "",
+ "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.",
+ "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "UNHEALTHY",
+ "STALE_STATUS"
+ ],
+ "description": "Output-only. Additional state information that includes status reported by the agent.",
+ "type": "string"
+ }
+ },
+ "id": "ClusterStatus"
+ },
+ "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": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains the Pig queries.",
+ "type": "string"
+ },
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "scriptVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
+ "type": "object"
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
+ },
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
+ "type": "object"
+ }
+ },
+ "id": "PigJob"
+ },
+ "ListClustersResponse": {
+ "type": "object",
+ "properties": {
+ "clusters": {
+ "type": "array",
+ "items": {
+ "$ref": "Cluster"
+ },
+ "description": "Output-only. The clusters in the project."
+ },
+ "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 ListClustersRequest.",
+ "type": "string"
+ }
+ },
+ "id": "ListClustersResponse",
+ "description": "The list of all clusters in a project."
+ },
+ "Job": {
+ "description": "A Cloud Dataproc job resource.",
+ "type": "object",
+ "properties": {
+ "hadoopJob": {
+ "description": "Job is a Hadoop job.",
+ "$ref": "HadoopJob"
},
"status": {
- "description": "Output-only Current operation status.",
- "$ref": "OperationStatus"
+ "$ref": "JobStatus",
+ "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields."
+ },
+ "placement": {
+ "$ref": "JobPlacement",
+ "description": "Required. Job information, including how, when, and where to run the job."
+ },
+ "driverControlFilesUri": {
+ "type": "string",
+ "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri."
+ },
+ "scheduling": {
+ "description": "Optional. Job scheduling configuration.",
+ "$ref": "JobScheduling"
+ },
+ "pigJob": {
+ "$ref": "PigJob",
+ "description": "Job is a Pig job."
+ },
+ "hiveJob": {
+ "description": "Job is a Hive job.",
+ "$ref": "HiveJob"
+ },
+ "labels": {
+ "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "driverOutputResourceUri": {
+ "description": "Output-only. A URI pointing to the location of the stdout of the job's driver program.",
+ "type": "string"
+ },
+ "statusHistory": {
+ "description": "Output-only. The previous job status.",
+ "type": "array",
+ "items": {
+ "$ref": "JobStatus"
+ }
+ },
+ "sparkJob": {
+ "$ref": "SparkJob",
+ "description": "Job is a Spark job."
+ },
+ "sparkSqlJob": {
+ "description": "Job is a SparkSql job.",
+ "$ref": "SparkSqlJob"
+ },
+ "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": {
+ "$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"
+ }
+ },
+ "id": "Job"
+ },
+ "SparkJob": {
+ "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
+ "type": "object",
+ "properties": {
+ "archiveUris": {
+ "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file that contains the main class.",
+ "type": "string"
+ },
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
+ },
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object"
+ },
+ "args": {
+ "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
+ "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"
+ }
+ },
+ "id": "SparkJob"
+ },
+ "JobStatus": {
+ "properties": {
+ "stateStartTime": {
+ "description": "Output-only. The time when this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "substate": {
+ "enum": [
+ "UNSPECIFIED",
+ "SUBMITTED",
+ "QUEUED",
+ "STALE_STATUS"
+ ],
+ "description": "Output-only. Additional state information, which includes status reported by the agent.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "The Job is submitted to the agent.Applies to RUNNING state.",
+ "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
+ "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
+ ]
+ },
+ "state": {
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "PENDING",
+ "SETUP_DONE",
+ "RUNNING",
+ "CANCEL_PENDING",
+ "CANCEL_STARTED",
+ "CANCELLED",
+ "DONE",
+ "ERROR",
+ "ATTEMPT_FAILURE"
+ ],
+ "description": "Output-only. A state message specifying the overall job state.",
+ "type": "string",
+ "enumDescriptions": [
+ "The job state is unknown.",
+ "The job is pending; it has been submitted, but is not yet running.",
+ "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.",
+ "The job is running on the cluster.",
+ "A CancelJob request has been received, but is pending.",
+ "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
+ "The job cancellation was successful.",
+ "The job has completed successfully.",
+ "The job has completed, but encountered an error.",
+ "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
+ ]
},
"details": {
- "description": "A message containing any operation metadata details.",
+ "description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
+ "type": "string"
+ }
+ },
+ "id": "JobStatus",
+ "description": "Cloud Dataproc job status.",
+ "type": "object"
+ },
+ "ManagedGroupConfig": {
+ "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": "ManagedGroupConfig"
+ },
+ "ClusterOperationStatus": {
+ "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 currently running.",
- "The operation is done, either cancelled or completed."
+ "The operation is running.",
+ "The operation is done; either cancelled or completed."
],
"enum": [
"UNKNOWN",
@@ -1974,30 +1514,487 @@
"RUNNING",
"DONE"
],
- "description": "A message containing the operation state.",
+ "description": "Output-only. A message containing the operation state.",
"type": "string"
},
- "clusterUuid": {
- "type": "string",
- "description": "Cluster UUId for the operation."
- },
- "clusterName": {
- "description": "Name of the cluster for the operation.",
+ "details": {
+ "description": "Output-only.A message containing any operation metadata details.",
"type": "string"
},
"innerState": {
- "description": "A message containing the detailed operation state.",
+ "description": "Output-only. A message containing the detailed operation state.",
"type": "string"
}
},
- "id": "OperationMetadata"
+ "id": "ClusterOperationStatus",
+ "description": "The status of the operation."
+ },
+ "YarnApplication": {
+ "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
+ "type": "object",
+ "properties": {
+ "state": {
+ "enumDescriptions": [
+ "Status is unspecified.",
+ "Status is NEW.",
+ "Status is NEW_SAVING.",
+ "Status is SUBMITTED.",
+ "Status is ACCEPTED.",
+ "Status is RUNNING.",
+ "Status is FINISHED.",
+ "Status is FAILED.",
+ "Status is KILLED."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "NEW",
+ "NEW_SAVING",
+ "SUBMITTED",
+ "ACCEPTED",
+ "RUNNING",
+ "FINISHED",
+ "FAILED",
+ "KILLED"
+ ],
+ "description": "Required. The application state.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The application name.",
+ "type": "string"
+ },
+ "trackingUrl": {
+ "type": "string",
+ "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access."
+ },
+ "progress": {
+ "description": "Required. The numerical progress of the application, from 1 to 100.",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "YarnApplication"
+ },
+ "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",
+ "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": {
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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."
+ },
+ "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"
+ },
+ "properties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code."
+ }
+ },
+ "id": "HadoopJob"
+ },
+ "DiagnoseClusterRequest": {
+ "id": "DiagnoseClusterRequest",
+ "description": "A request to collect cluster diagnostic information.",
+ "type": "object",
+ "properties": {}
+ },
+ "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",
+ "description": "Specifies the config of disk options for a group of VM instances."
+ },
+ "ClusterOperationMetadata": {
+ "properties": {
+ "operationType": {
+ "description": "Output-only. The operation type.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Output-only. Short description of operation.",
+ "type": "string"
+ },
+ "warnings": {
+ "description": "Output-only. Errors encountered during operation execution.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Output-only. Labels associated with the operation",
+ "type": "object"
+ },
+ "status": {
+ "$ref": "ClusterOperationStatus",
+ "description": "Output-only. Current operation status."
+ },
+ "statusHistory": {
+ "description": "Output-only. The previous operation status.",
+ "type": "array",
+ "items": {
+ "$ref": "ClusterOperationStatus"
+ }
+ },
+ "clusterName": {
+ "description": "Output-only. Name of the cluster for the operation.",
+ "type": "string"
+ },
+ "clusterUuid": {
+ "description": "Output-only. Cluster UUID for the operation.",
+ "type": "string"
+ }
+ },
+ "id": "ClusterOperationMetadata",
+ "description": "Metadata describing the operation.",
+ "type": "object"
+ },
+ "HiveJob": {
+ "properties": {
+ "continueOnFailure": {
+ "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
+ "type": "boolean"
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains Hive queries.",
+ "type": "string"
+ },
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ },
+ "scriptVariables": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";)."
+ },
+ "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"
+ }
+ },
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
+ "type": "object"
+ }
+ },
+ "id": "HiveJob",
+ "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
+ "type": "object"
+ },
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object"
+ },
+ "DiagnoseClusterResults": {
+ "id": "DiagnoseClusterResults",
+ "description": "The location of diagnostic output.",
+ "type": "object",
+ "properties": {
+ "outputUri": {
+ "type": "string",
+ "description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics."
+ }
+ }
+ },
+ "ClusterConfig": {
+ "description": "The cluster config.",
+ "type": "object",
+ "properties": {
+ "masterConfig": {
+ "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster.",
+ "$ref": "InstanceGroupConfig"
+ },
+ "secondaryWorkerConfig": {
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster."
+ },
+ "initializationActions": {
+ "description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
+ "type": "array",
+ "items": {
+ "$ref": "NodeInitializationAction"
+ }
+ },
+ "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": {
+ "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster.",
+ "$ref": "InstanceGroupConfig"
+ },
+ "gceClusterConfig": {
+ "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster.",
+ "$ref": "GceClusterConfig"
+ },
+ "softwareConfig": {
+ "description": "Optional. The config settings for software inside the cluster.",
+ "$ref": "SoftwareConfig"
+ }
+ },
+ "id": "ClusterConfig"
+ },
+ "PySparkJob": {
+ "description": "A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.",
+ "type": "object",
+ "properties": {
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "loggingConfig": {
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
+ },
+ "properties": {
+ "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "args": {
+ "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "fileUris": {
+ "description": "Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "pythonFileUris": {
+ "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mainPythonFileUri": {
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "PySparkJob"
+ },
+ "GceClusterConfig": {
+ "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "type": "object",
+ "properties": {
+ "subnetworkUri": {
+ "type": "string",
+ "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."
+ },
+ "networkUri": {
+ "type": "string",
+ "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."
+ },
+ "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": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "serviceAccountScopes": {
+ "description": "Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control",
+ "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": {
+ "type": "string",
+ "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"
+ }
+ },
+ "id": "GceClusterConfig"
+ },
+ "AcceleratorConfig": {
+ "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
+ "type": "object",
+ "properties": {
+ "acceleratorCount": {
+ "description": "The number of the accelerator cards of this type exposed to this instance.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "acceleratorTypeUri": {
+ "description": "Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)",
+ "type": "string"
+ }
+ },
+ "id": "AcceleratorConfig"
+ },
+ "ClusterMetrics": {
+ "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
+ "type": "object",
+ "properties": {
+ "yarnMetrics": {
+ "description": "The YARN metrics.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "format": "int64"
+ }
+ },
+ "hdfsMetrics": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "The HDFS metrics.",
+ "type": "object"
+ }
+ },
+ "id": "ClusterMetrics"
+ },
+ "LoggingConfig": {
+ "type": "object",
+ "properties": {
+ "driverLogLevels": {
+ "additionalProperties": {
+ "enum": [
+ "LEVEL_UNSPECIFIED",
+ "ALL",
+ "TRACE",
+ "DEBUG",
+ "INFO",
+ "WARN",
+ "ERROR",
+ "FATAL",
+ "OFF"
+ ],
+ "type": "string"
+ },
+ "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
+ "type": "object"
+ }
+ },
+ "id": "LoggingConfig",
+ "description": "The runtime logging config of the job."
+ },
+ "DiagnoseClusterOutputLocation": {
+ "description": "The location where output from diagnostic command can be found.",
+ "type": "object",
+ "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"
}
},
- "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": "v1",
"baseUrl": "https://dataproc.googleapis.com/",
"auth": {
@@ -2009,8 +2006,11 @@
}
}
},
- "servicePath": "",
- "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
"kind": "discovery#restDescription",
- "rootUrl": "https://dataproc.googleapis.com/"
+ "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+ "servicePath": "",
+ "rootUrl": "https://dataproc.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "dataproc"
}
diff --git a/dataproc/v1/dataproc-gen.go b/dataproc/v1/dataproc-gen.go
index e6a0f8f..3fad6fb 100644
--- a/dataproc/v1/dataproc-gen.go
+++ b/dataproc/v1/dataproc-gen.go
@@ -1892,7 +1892,7 @@
// 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
+// error detail types in the package google.rpc that can be used for
// common error conditions.Language mappingThe Status message is the
// logical representation of the error model, but it is not necessarily
// the actual wire format. When the Status message is exposed in
@@ -1907,7 +1907,7 @@
// 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.
+// have a Status message for error reporting.
// 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.
@@ -4509,9 +4509,14 @@
// 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.
+// UNIMPLEMENTED.NOTE: the name binding allows API services to override
+// the binding to use different resource name schemes, such as
+// users/*/operations. To override the binding, API services can add a
+// binding such as "/v1/{name=users/*}/operations" to their service
+// configuration. For backwards compatibility, the default name includes
+// the operations collection id, however overriding users must ensure
+// the name binding is the parent resource, without the operations
+// collection id.
func (r *ProjectsRegionsOperationsService) List(name string) *ProjectsRegionsOperationsListCall {
c := &ProjectsRegionsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -4633,7 +4638,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
// "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
// "httpMethod": "GET",
// "id": "dataproc.projects.regions.operations.list",
@@ -4647,7 +4652,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "path",
// "pattern": "^projects/[^/]+/regions/[^/]+/operations$",
// "required": true,
diff --git a/dataproc/v1alpha1/dataproc-api.json b/dataproc/v1alpha1/dataproc-api.json
index ac668fa..1a88977 100644
--- a/dataproc/v1alpha1/dataproc-api.json
+++ b/dataproc/v1alpha1/dataproc-api.json
@@ -1,712 +1,419 @@
{
- "batchPath": "batch",
- "documentationLink": "https://cloud.google.com/dataproc/",
- "id": "dataproc:v1alpha1",
- "revision": "20170502",
- "title": "Google Cloud Dataproc API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "resources": {
- "operations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The operation resource name.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "filter": {
- "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",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "The operation collection name.",
- "required": true,
- "type": "string",
- "pattern": "^operations$"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The standard List page token."
- },
- "pageSize": {
- "location": "query",
- "description": "The standard List page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1alpha1/operations",
- "id": "dataproc.operations.list",
- "path": "v1alpha1/{+name}",
- "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."
- },
- "cancel": {
- "flatPath": "v1alpha1/operations/{operationsId}:cancel",
- "id": "dataproc.operations.cancel",
- "path": "v1alpha1/{+name}:cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. 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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "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.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted."
- }
- },
- "flatPath": "v1alpha1/operations/{operationsId}"
- }
- }
- },
- "projects": {
- "resources": {
- "regions": {
- "resources": {
- "jobs": {
- "methods": {
- "cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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": "CancelJobRequest"
- },
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs:list or regions/{region}/jobs:get."
- },
- "get": {
- "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.",
- "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": {
- "description": "Required The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "description": "Required The Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "patch": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to."
- },
- "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"
- },
- "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": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.patch",
- "request": {
- "$ref": "Job"
- },
- "description": "Updates a job in a project."
- },
- "submit": {
- "id": "dataproc.projects.regions.jobs.submit",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs:submit",
- "request": {
- "$ref": "SubmitJobRequest"
- },
- "description": "Submits a job to a cluster.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "region": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required The Dataproc region in which to handle the request."
- },
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs:submit"
- },
- "delete": {
- "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.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "location": "path",
- "description": "Required The job ID.",
- "required": true,
- "type": "string"
- },
- "region": {
- "description": "Required The 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/{jobId}"
- },
- "list": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameters": {
- "region": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required The Dataproc region in which to handle the request."
- },
- "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}/jobs:list",
- "id": "dataproc.projects.regions.jobs.list",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs:list",
- "request": {
- "$ref": "ListJobsRequest"
- },
- "description": "Lists regions/{region}/jobs in a project."
- }
- }
- },
- "clusters": {
- "methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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 Dataproc region in which to handle the request."
- }
- },
- "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",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Request to create a cluster in a project."
- },
- "delete": {
- "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": {
- "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"
- }
- },
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.delete",
- "description": "Request to delete a cluster in a project."
- },
- "patch": {
- "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Request to update a cluster in a project.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required The Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "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\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"
- },
- "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 the cluster belongs to.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
- },
- "get": {
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "description": "Request to get the resource representation for a cluster in a project.",
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "region": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required The Dataproc region in which to handle the request."
- },
- "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"
- }
- }
- },
- "list": {
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.list",
- "description": "Request a list of all regions/{region}/clusters in a project.",
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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": {
- "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"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "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."
- }
- },
"schemas": {
- "HadoopJob": {
- "description": "A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN.",
+ "LoggingConfiguration": {
+ "description": "The runtime logging configuration of the job.",
"type": "object",
"properties": {
- "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.",
+ "driverLogLevels": {
+ "additionalProperties": {
+ "enum": [
+ "LEVEL_UNSPECIFIED",
+ "ALL",
+ "TRACE",
+ "DEBUG",
+ "INFO",
+ "WARN",
+ "ERROR",
+ "FATAL",
+ "OFF"
+ ],
+ "type": "string"
+ },
+ "description": "The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG",
+ "type": "object"
+ }
+ },
+ "id": "LoggingConfiguration"
+ },
+ "ClusterConfiguration": {
+ "description": "The cluster configuration.",
+ "type": "object",
+ "properties": {
+ "workerConfiguration": {
+ "description": "Optional The Google Compute Engine configuration settings for worker instances in a cluster.",
+ "$ref": "InstanceGroupConfiguration"
+ },
+ "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",
"items": {
- "type": "string"
+ "$ref": "NodeInitializationAction"
}
},
- "fileUris": {
- "description": "Optional HCFS 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"
- }
+ "gceClusterConfiguration": {
+ "$ref": "GceClusterConfiguration",
+ "description": "Optional The shared Google Compute Engine configuration settings for all instances in a cluster."
},
- "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.",
+ "softwareConfiguration": {
+ "$ref": "SoftwareConfiguration",
+ "description": "Optional The configuration settings for software inside the 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.",
"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.",
+ "numWorkers": {
+ "description": "Deprecated The number of worker nodes in the cluster.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "masterDiskConfiguration": {
+ "description": "Deprecated The configuration settings of master node disk options.",
+ "$ref": "DiskConfiguration"
+ },
+ "workerDiskConfiguration": {
+ "$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."
+ },
+ "secondaryWorkerConfiguration": {
+ "$ref": "InstanceGroupConfiguration",
+ "description": "Optional The Google Compute Engine configuration settings for additional worker instances in a cluster."
+ },
+ "masterName": {
+ "description": "Deprecated The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.",
+ "type": "string"
+ },
+ "workers": {
+ "description": "Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ClusterConfiguration"
+ },
+ "ClusterMetrics": {
+ "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.",
+ "type": "object",
+ "properties": {
+ "hdfsMetrics": {
+ "description": "The HDFS metrics.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "yarnMetrics": {
+ "description": "The YARN metrics.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "id": "ClusterMetrics"
+ },
+ "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": {
+ "description": "Disk option configuration settings.",
+ "$ref": "DiskConfiguration"
+ },
+ "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": {
+ "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"
+ },
+ "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",
"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",
+ "accelerators": {
+ "description": "Optional The Google Compute Engine accelerator configuration for these instances.",
+ "type": "array",
+ "items": {
+ "$ref": "AcceleratorConfiguration"
+ }
+ },
+ "numInstances": {
+ "description": "The number of VM instances in the instance group. For master instance groups, must be set to 1.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "InstanceGroupConfiguration"
+ },
+ "GceClusterConfiguration": {
+ "description": "Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "metadata": {
+ "description": "The Google Compute Engine metadata entries to add to all instances.",
+ "type": "object",
+ "additionalProperties": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "GceClusterConfiguration"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
+ "DiagnoseClusterOutputLocation": {
+ "description": "The location where output from diagnostic command can be found.",
+ "type": "object",
+ "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"
+ },
+ "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": {
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation.",
+ "type": "object"
+ },
+ "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"
+ },
+ "name": {
+ "description": "The name of the operation resource, in the format projects/project_id/operations/operation_id",
+ "type": "string"
+ }
+ },
+ "id": "Operation"
+ },
+ "OperationStatus": {
+ "description": "The status of the operation.",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "A message containing the operation state.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is running.",
+ "The operation is done; either cancelled or completed."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PENDING",
+ "RUNNING",
+ "DONE"
+ ]
+ },
+ "details": {
+ "description": "A message containing any operation metadata details.",
+ "type": "string"
+ },
+ "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"
+ },
+ "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": "Required 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 dashes (-). The maximum length is 100 characters.",
+ "type": "string"
+ }
+ },
+ "id": "JobReference"
+ },
+ "SubmitJobRequest": {
+ "description": "A job submission request.",
+ "type": "object",
+ "properties": {
+ "job": {
+ "$ref": "Job",
+ "description": "Required The job resource."
+ }
+ },
+ "id": "SubmitJobRequest"
+ },
+ "Status": {
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There 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"
+ }
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "id": "Status"
+ },
+ "JobScheduling": {
+ "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": {
+ "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"
+ },
+ "ListJobsResponse": {
+ "description": "A response to a request to list jobs in a project.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Optional This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
+ "type": "string"
+ },
+ "jobs": {
+ "description": "Output-only Jobs list.",
+ "type": "array",
+ "items": {
+ "$ref": "Job"
+ }
+ }
+ },
+ "id": "ListJobsResponse"
+ },
+ "CancelJobRequest": {
+ "description": "A request to cancel a job.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelJobRequest"
+ },
+ "SparkSqlJob": {
+ "description": "A Cloud Dataproc job for running Spark SQL queries.",
+ "type": "object",
+ "properties": {
+ "scriptVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
+ "type": "object"
+ },
"jarFileUris": {
- "description": "Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
+ "description": "Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.",
"type": "array",
"items": {
"type": "string"
@@ -720,28 +427,601 @@
"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.",
+ "description": "Optional A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
"type": "object"
+ },
+ "queryList": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains SQL queries.",
+ "type": "string"
}
},
- "id": "HadoopJob"
+ "id": "SparkSqlJob"
},
- "QueryList": {
- "description": "A list of queries to run on a cluster.",
+ "Cluster": {
+ "description": "Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.",
"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",
+ "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"
+ },
+ "createTime": {
+ "description": "Output-only The timestamp of cluster creation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.",
+ "type": "object"
+ },
+ "metrics": {
+ "$ref": "ClusterMetrics",
+ "description": "Contains cluster daemon metrics such as HDFS and YARN stats."
+ },
+ "status": {
+ "$ref": "ClusterStatus",
+ "description": "Output-only Cluster status."
+ },
+ "statusHistory": {
+ "description": "Output-only Previous cluster statuses.",
+ "type": "array",
+ "items": {
+ "$ref": "ClusterStatus"
+ }
+ },
+ "clusterName": {
+ "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.",
+ "type": "string"
+ }
+ },
+ "id": "Cluster"
+ },
+ "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 match the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "OperationMetadata": {
+ "description": "Metadata describing the operation.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Output-only Current operation status.",
+ "$ref": "OperationStatus"
+ },
+ "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"
+ },
+ "details": {
+ "description": "A message containing any operation metadata details.",
+ "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"
+ },
+ "startTime": {
+ "description": "The time that the operation was started by the server.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "warnings": {
+ "description": "Output-only Errors encountered during operation execution.",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "insertTime": {
+ "description": "The time that the operation was requested.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "statusHistory": {
+ "description": "Output-only Previous operation status.",
+ "type": "array",
+ "items": {
+ "$ref": "OperationStatus"
+ }
+ },
+ "operationType": {
+ "description": "Output-only The operation type.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Output-only Short description of operation.",
+ "type": "string"
}
},
- "id": "QueryList"
+ "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.",
+ "type": "string"
+ },
+ "clusterUuid": {
+ "description": "Output-only A cluster UUID generated by the Dataproc service when the job is submitted.",
+ "type": "string"
+ }
+ },
+ "id": "JobPlacement"
+ },
+ "ClusterStatus": {
+ "description": "The status of a cluster and its instances.",
+ "type": "object",
+ "properties": {
+ "detail": {
+ "description": "Optional details of cluster's state.",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "The cluster state is unknown.",
+ "The cluster is being created and set up. It is not ready for use.",
+ "The cluster is currently running and healthy. It is ready for use.",
+ "The cluster encountered an error. It is not ready for use.",
+ "The cluster is being deleted. It cannot be used.",
+ "The cluster is being updated. It continues to accept and process jobs."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "CREATING",
+ "RUNNING",
+ "ERROR",
+ "DELETING",
+ "UPDATING"
+ ],
+ "description": "The cluster's state.",
+ "type": "string"
+ },
+ "stateStartTime": {
+ "description": "Time when this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "substate": {
+ "description": "Output-only Additional state information that includes status reported by the agent.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.",
+ "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "UNHEALTHY",
+ "STALE_STATUS"
+ ]
+ }
+ },
+ "id": "ClusterStatus"
+ },
+ "PigJob": {
+ "description": "A Cloud Dataproc job for running Pig queries on YARN.",
+ "type": "object",
+ "properties": {
+ "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",
+ "items": {
+ "type": "string"
+ }
+ },
+ "scriptVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional Mapping of query variable names to values (equivalent to the Pig command: \"name=value\").",
+ "type": "object"
+ },
+ "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"
+ },
+ "continueOnFailure": {
+ "description": "Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
+ "type": "boolean"
+ },
+ "queryList": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains the Pig queries.",
+ "type": "string"
+ }
+ },
+ "id": "PigJob"
+ },
+ "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": {
+ "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)",
+ "type": "string"
+ },
+ "acceleratorCount": {
+ "description": "The number of the accelerator cards of this type exposed to this instance.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "AcceleratorConfiguration"
+ },
+ "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"
+ },
+ "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.",
+ "type": "string"
+ },
+ "instanceTemplateName": {
+ "description": "Output-only The name of Instance Template used for Managed Instance Group.",
+ "type": "string"
+ }
+ },
+ "id": "ManagedGroupConfiguration"
+ },
+ "SparkJob": {
+ "description": "A Cloud Dataproc job for running Spark applications on YARN.",
+ "type": "object",
+ "properties": {
+ "jarFileUris": {
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
+ "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"
+ },
+ "Job": {
+ "description": "A Cloud Dataproc job resource.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "Job is a Hadoop job.",
+ "$ref": "HadoopJob"
+ },
+ "placement": {
+ "description": "Required Job information, including how, when, and where to run the job.",
+ "$ref": "JobPlacement"
+ },
+ "status": {
+ "description": "Output-only The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields.",
+ "$ref": "JobStatus"
+ },
+ "driverControlFilesUri": {
+ "description": "Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
+ "type": "string"
+ },
+ "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": {
+ "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": {
+ "$ref": "HiveJob",
+ "description": "Job is a Hive job."
+ },
+ "labels": {
+ "description": "Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "driverOutputResourceUri": {
+ "description": "Output-only A URI pointing to the location of the stdout of the job's driver program.",
+ "type": "string"
+ },
+ "statusHistory": {
+ "description": "Output-only The previous job status.",
+ "type": "array",
+ "items": {
+ "$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"
+ }
+ },
+ "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, then 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"
+ }
+ },
+ "id": "Job"
+ },
+ "JobStatus": {
+ "description": "Cloud Dataproc job status.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "description": "The time when the job completed.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The time when the server started the job.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "substate": {
+ "enumDescriptions": [
+ "",
+ "The Job is submitted to the agent.Applies to RUNNING state.",
+ "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
+ "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "SUBMITTED",
+ "QUEUED",
+ "STALE_STATUS"
+ ],
+ "description": "Output-only Additional state information, which includes status reported by the agent.",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "The time of the job request.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "details": {
+ "description": "Optional Job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
+ "type": "string"
+ },
+ "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.",
+ "Job has been received by the service and completed initial setup; it will shortly be submitted to the cluster.",
+ "The job is running on the cluster.",
+ "A CancelJob request has been received, but is pending.",
+ "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
+ "The job cancelation was successful.",
+ "The job has completed successfully.",
+ "The job has completed, but encountered an error.",
+ "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "PENDING",
+ "SETUP_DONE",
+ "RUNNING",
+ "CANCEL_PENDING",
+ "CANCEL_STARTED",
+ "CANCELLED",
+ "DONE",
+ "ERROR",
+ "ATTEMPT_FAILURE"
+ ]
+ },
+ "stateStartTime": {
+ "description": "Output-only The time when this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "JobStatus"
+ },
+ "DiskConfiguration": {
+ "description": "Specifies the configuration of disk options for a group of VM instances.",
+ "type": "object",
+ "properties": {
+ "numLocalSsds": {
+ "description": "Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS 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"
+ },
+ "bootDiskSizeGb": {
+ "description": "Optional Size in GB of the boot disk (default is 500GB).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DiskConfiguration"
+ },
+ "ClusterOperationStatus": {
+ "description": "The status of the operation.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "state": {
+ "description": "Output-only. A message containing the operation state.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is running.",
+ "The operation is done; either cancelled or completed."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PENDING",
+ "RUNNING",
+ "DONE"
+ ]
+ },
+ "details": {
+ "description": "Output-only.A message containing any operation metadata details.",
+ "type": "string"
+ }
+ },
+ "id": "ClusterOperationStatus"
},
"YarnApplication": {
- "id": "YarnApplication",
"description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.",
"type": "object",
"properties": {
@@ -780,17 +1060,111 @@
"type": "string"
},
"progress": {
- "type": "number",
"description": "Required The numerical progress of the application, from 1 to 100.",
- "format": "float"
+ "format": "float",
+ "type": "number"
}
- }
+ },
+ "id": "YarnApplication"
+ },
+ "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",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "QueryList"
+ },
+ "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",
+ "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 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 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"
+ }
+ }
+ },
+ "id": "HadoopJob"
},
"ClusterOperationMetadata": {
- "id": "ClusterOperationMetadata",
"description": "Metadata describing the operation.",
"type": "object",
"properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Output-only. Labels associated with the operation",
+ "type": "object"
+ },
+ "status": {
+ "description": "Output-only. Current operation status.",
+ "$ref": "ClusterOperationStatus"
+ },
+ "statusHistory": {
+ "description": "Output-only. The previous operation status.",
+ "type": "array",
+ "items": {
+ "$ref": "ClusterOperationStatus"
+ }
+ },
+ "clusterUuid": {
+ "description": "Output-only. Cluster UUID for the operation.",
+ "type": "string"
+ },
+ "clusterName": {
+ "description": "Output-only. Name of the cluster for the operation.",
+ "type": "string"
+ },
"operationType": {
"description": "Output-only. The operation type.",
"type": "string"
@@ -805,34 +1179,9 @@
"items": {
"type": "string"
}
- },
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Output-only. Labels associated with the operation"
- },
- "status": {
- "description": "Output-only. Current operation status.",
- "$ref": "ClusterOperationStatus"
- },
- "statusHistory": {
- "description": "Output-only. The previous operation status.",
- "type": "array",
- "items": {
- "$ref": "ClusterOperationStatus"
- }
- },
- "clusterName": {
- "type": "string",
- "description": "Output-only. Name of the cluster for the operation."
- },
- "clusterUuid": {
- "description": "Output-only. Cluster UUID for the operation.",
- "type": "string"
}
- }
+ },
+ "id": "ClusterOperationMetadata"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
@@ -841,19 +1190,9 @@
"id": "Empty"
},
"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"
- },
"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",
@@ -874,14 +1213,23 @@
},
"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"
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains Hive queries.",
+ "type": "string"
}
},
- "id": "HiveJob",
- "description": "A Cloud Dataproc job for running Hive queries on YARN.",
- "type": "object"
+ "id": "HiveJob"
},
"ListJobsRequest": {
- "id": "ListJobsRequest",
"description": "A request to list jobs in a project.",
"type": "object",
"properties": {
@@ -890,6 +1238,8 @@
"type": "string"
},
"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",
@@ -899,9 +1249,7 @@
"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.",
@@ -916,21 +1264,21 @@
"format": "int32",
"type": "integer"
}
- }
+ },
+ "id": "ListJobsRequest"
},
"DiagnoseClusterResults": {
"description": "The location of diagnostic output.",
"type": "object",
"properties": {
"outputUri": {
- "type": "string",
- "description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics."
+ "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"
},
"GceConfiguration": {
- "id": "GceConfiguration",
"description": "Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
"type": "object",
"properties": {
@@ -957,27 +1305,30 @@
"description": "Deprecated 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": "GceConfiguration"
},
"SoftwareConfiguration": {
+ "description": "Specifies the selection and configuration 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 will default to latest version."
- },
"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"
+ }
+ },
+ "imageVersion": {
+ "description": "Optional The version of software inside the cluster. It must match the regular expression 0-9+.0-9+. If unspecified it will default to latest version.",
+ "type": "string"
}
},
- "id": "SoftwareConfiguration",
- "description": "Specifies the selection and configuration of software inside the cluster."
+ "id": "SoftwareConfiguration"
},
"PySparkJob": {
+ "description": "A Cloud Dataproc job for running PySpark applications on YARN.",
+ "type": "object",
"properties": {
"args": {
"description": "Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
@@ -1001,8 +1352,8 @@
}
},
"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."
+ "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"
},
"archiveUris": {
"description": "Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.",
@@ -1019,1048 +1370,25 @@
}
},
"loggingConfiguration": {
- "description": "Optional The runtime log configuration for job execution.",
- "$ref": "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",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "id": "PySparkJob",
- "description": "A Cloud Dataproc job for running PySpark applications on YARN.",
- "type": "object"
- },
- "LoggingConfiguration": {
- "id": "LoggingConfiguration",
- "description": "The runtime logging configuration of the job.",
- "type": "object",
- "properties": {
- "driverLogLevels": {
- "additionalProperties": {
- "enum": [
- "LEVEL_UNSPECIFIED",
- "ALL",
- "TRACE",
- "DEBUG",
- "INFO",
- "WARN",
- "ERROR",
- "FATAL",
- "OFF"
- ],
- "type": "string"
- },
- "description": "The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG",
- "type": "object"
- }
- }
- },
- "ClusterConfiguration": {
- "properties": {
- "secondaryWorkerConfiguration": {
- "$ref": "InstanceGroupConfiguration",
- "description": "Optional The Google Compute Engine configuration settings for additional worker instances in a cluster."
- },
- "masterName": {
- "description": "Deprecated The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.",
- "type": "string"
- },
- "workers": {
- "description": "Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "workerConfiguration": {
- "description": "Optional The Google Compute Engine configuration settings for worker instances in a cluster.",
- "$ref": "InstanceGroupConfiguration"
- },
- "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",
- "items": {
- "$ref": "NodeInitializationAction"
- }
- },
- "softwareConfiguration": {
- "description": "Optional The configuration settings for software inside the cluster.",
- "$ref": "SoftwareConfiguration"
- },
- "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.",
- "type": "string"
- },
- "numWorkers": {
- "description": "Deprecated The number of worker nodes in the cluster.",
- "format": "int32",
- "type": "integer"
- },
- "masterDiskConfiguration": {
- "$ref": "DiskConfiguration",
- "description": "Deprecated The configuration settings of master node disk options."
- },
- "workerDiskConfiguration": {
- "description": "Deprecated The configuration settings of worker node disk options.",
- "$ref": "DiskConfiguration"
- },
- "gceConfiguration": {
- "description": "Deprecated The Google Compute Engine configuration settings for cluster resources.",
- "$ref": "GceConfiguration"
- },
- "masterConfiguration": {
- "description": "Optional The Google Compute Engine configuration settings for the master instance in a cluster.",
- "$ref": "InstanceGroupConfiguration"
- }
- },
- "id": "ClusterConfiguration",
- "description": "The cluster configuration.",
- "type": "object"
- },
- "ClusterMetrics": {
- "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.",
- "type": "object",
- "properties": {
- "yarnMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The YARN metrics.",
- "type": "object"
- },
- "hdfsMetrics": {
- "description": "The HDFS metrics.",
- "type": "object",
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- }
- }
- },
- "id": "ClusterMetrics"
- },
- "InstanceGroupConfiguration": {
- "description": "The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- },
- "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",
- "items": {
- "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"
- },
- "accelerators": {
- "description": "Optional The Google Compute Engine accelerator configuration for these instances.",
- "type": "array",
- "items": {
- "$ref": "AcceleratorConfiguration"
- }
- },
- "numInstances": {
- "description": "The number of VM instances in the instance group. For master instance groups, must be set to 1.",
- "format": "int32",
- "type": "integer"
- },
- "diskConfiguration": {
- "$ref": "DiskConfiguration",
- "description": "Disk option configuration settings."
- }
- },
- "id": "InstanceGroupConfiguration"
- },
- "GceClusterConfiguration": {
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "GceClusterConfiguration",
- "description": "Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
- "type": "object"
- },
- "CancelOperationRequest": {
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation.",
- "type": "object"
- },
- "DiagnoseClusterOutputLocation": {
- "description": "The location where output from diagnostic command can be found.",
- "type": "object",
- "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"
- },
- "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": {
- "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"
- },
- "name": {
- "description": "The name of the operation resource, in the format projects/project_id/operations/operation_id",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure.",
- "$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.",
"type": "object"
}
},
- "id": "Operation"
- },
- "OperationStatus": {
- "description": "The status of the operation.",
- "type": "object",
- "properties": {
- "stateStartTime": {
- "type": "string",
- "description": "The time this state was entered.",
- "format": "google-datetime"
- },
- "state": {
- "type": "string",
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ],
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ],
- "description": "A message containing the operation state."
- },
- "details": {
- "description": "A message containing any operation metadata details.",
- "type": "string"
- },
- "innerState": {
- "type": "string",
- "description": "A message containing the detailed operation state."
- }
- },
- "id": "OperationStatus"
- },
- "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": "Required 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 dashes (-). The maximum length is 100 characters.",
- "type": "string"
- }
- },
- "id": "JobReference"
- },
- "SubmitJobRequest": {
- "description": "A job submission request.",
- "type": "object",
- "properties": {
- "job": {
- "$ref": "Job",
- "description": "Required The job resource."
- }
- },
- "id": "SubmitJobRequest"
- },
- "Status": {
- "type": "object",
- "properties": {
- "code": {
- "type": "integer",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any 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": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- }
- },
- "id": "Status",
- "description": "The Status type defines a logical error model that is suitable for different 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."
- },
- "JobScheduling": {
- "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",
- "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"
- }
- }
- },
- "ListJobsResponse": {
- "description": "A response to a request to list jobs in a project.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- },
- "CancelJobRequest": {
- "properties": {},
- "id": "CancelJobRequest",
- "description": "A request to cancel a job.",
- "type": "object"
- },
- "SparkSqlJob": {
- "type": "object",
- "properties": {
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains SQL queries.",
- "type": "string"
- },
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
- "type": "object"
- },
- "jarFileUris": {
- "description": "Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.",
- "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 SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
- "type": "object"
- }
- },
- "id": "SparkSqlJob",
- "description": "A Cloud Dataproc job for running Spark SQL queries."
- },
- "Cluster": {
- "description": "Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.",
- "type": "object",
- "properties": {
- "configuration": {
- "$ref": "ClusterConfiguration",
- "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."
- },
- "createTime": {
- "description": "Output-only The timestamp of cluster creation.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "description": "Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "metrics": {
- "$ref": "ClusterMetrics",
- "description": "Contains cluster daemon metrics such as HDFS and YARN stats."
- },
- "status": {
- "$ref": "ClusterStatus",
- "description": "Output-only Cluster status."
- },
- "statusHistory": {
- "description": "Output-only Previous cluster statuses.",
- "type": "array",
- "items": {
- "$ref": "ClusterStatus"
- }
- },
- "clusterName": {
- "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.",
- "type": "string"
- },
- "projectId": {
- "description": "Required The Google Cloud Platform project ID that the cluster belongs to.",
- "type": "string"
- }
- },
- "id": "Cluster"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "operations": {
- "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"
- },
- "OperationMetadata": {
- "description": "Metadata describing the operation.",
- "type": "object",
- "properties": {
- "statusHistory": {
- "description": "Output-only Previous operation status.",
- "type": "array",
- "items": {
- "$ref": "OperationStatus"
- }
- },
- "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."
- },
- "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"
- ]
- },
- "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": {
- "description": "The time that the operation completed.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "The time that the operation was started by the server.",
- "format": "google-datetime",
- "type": "string"
- },
- "warnings": {
- "description": "Output-only Errors encountered during operation execution.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "The time that the operation was requested.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "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.",
- "type": "string"
- },
- "clusterUuid": {
- "description": "Output-only A cluster UUID generated by the Dataproc service when the job is submitted.",
- "type": "string"
- }
- },
- "id": "JobPlacement"
- },
- "ClusterStatus": {
- "id": "ClusterStatus",
- "description": "The status of a cluster and its instances.",
- "type": "object",
- "properties": {
- "stateStartTime": {
- "type": "string",
- "description": "Time when this state was entered.",
- "format": "google-datetime"
- },
- "substate": {
- "type": "string",
- "enumDescriptions": [
- "",
- "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.",
- "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
- ],
- "enum": [
- "UNSPECIFIED",
- "UNHEALTHY",
- "STALE_STATUS"
- ],
- "description": "Output-only Additional state information that includes status reported by the agent."
- },
- "detail": {
- "description": "Optional details of cluster's state.",
- "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.",
- "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"
- ]
- }
- }
- },
- "PigJob": {
- "description": "A Cloud Dataproc job for running Pig queries on YARN.",
- "type": "object",
- "properties": {
- "queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains the Pig queries.",
- "type": "string"
- },
- "jarFileUris": {
- "description": "Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional Mapping of query variable names to values (equivalent to the Pig command: \"name=value\").",
- "type": "object"
- },
- "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"
- },
- "continueOnFailure": {
- "description": "Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
- "type": "boolean"
- }
- },
- "id": "PigJob"
- },
- "AcceleratorConfiguration": {
- "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",
- "properties": {
- "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)",
- "type": "string"
- },
- "acceleratorCount": {
- "description": "The number of the accelerator cards of this type exposed to this instance.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "ListClustersResponse": {
- "id": "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": {
- "type": "string",
- "description": "The standard List next-page token."
- }
- }
- },
- "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.",
- "type": "string"
- },
- "instanceTemplateName": {
- "description": "Output-only The name of Instance Template used for Managed Instance Group.",
- "type": "string"
- }
- },
- "id": "ManagedGroupConfiguration"
- },
- "Job": {
- "type": "object",
- "properties": {
- "driverOutputResourceUri": {
- "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": {
- "description": "Job is a SparkSql job.",
- "$ref": "SparkSqlJob"
- },
- "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": {
- "$ref": "JobReference",
- "description": "Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e."
- },
- "interactive": {
- "description": "Optional If set to true, then 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": {
- "type": "string",
- "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."
- },
- "hadoopJob": {
- "$ref": "HadoopJob",
- "description": "Job is a Hadoop job."
- },
- "placement": {
- "description": "Required Job information, including how, when, and where to run the job.",
- "$ref": "JobPlacement"
- },
- "status": {
- "$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": {
- "type": "string",
- "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."
- },
- "scheduling": {
- "$ref": "JobScheduling",
- "description": "Optional Job scheduling configuration."
- },
- "pigJob": {
- "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"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.",
- "type": "object"
- }
- },
- "id": "Job",
- "description": "A Cloud Dataproc job resource."
- },
- "SparkJob": {
- "id": "SparkJob",
- "description": "A Cloud Dataproc job for running Spark applications on YARN.",
- "type": "object",
- "properties": {
- "mainClass": {
- "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainJarFileUri": {
- "description": "The 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": {
- "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."
- },
- "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"
- }
- }
- }
- },
- "DiskConfiguration": {
- "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",
- "description": "Specifies the configuration of disk options for a group of VM instances.",
- "type": "object"
- },
- "JobStatus": {
- "description": "Cloud Dataproc job status.",
- "type": "object",
- "properties": {
- "substate": {
- "enum": [
- "UNSPECIFIED",
- "SUBMITTED",
- "QUEUED",
- "STALE_STATUS"
- ],
- "description": "Output-only Additional state information, which includes status reported by the agent.",
- "type": "string",
- "enumDescriptions": [
- "",
- "The Job is submitted to the agent.Applies to RUNNING state.",
- "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
- "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
- ]
- },
- "insertTime": {
- "description": "The time of the job request.",
- "format": "google-datetime",
- "type": "string"
- },
- "details": {
- "description": "Optional Job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "The job state is unknown.",
- "The job is pending; it has been submitted, but is not yet running.",
- "Job has been received by the service and completed initial setup; it will shortly be submitted to the cluster.",
- "The job is running on the cluster.",
- "A CancelJob request has been received, but is pending.",
- "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
- "The job cancelation was successful.",
- "The job has completed successfully.",
- "The job has completed, but encountered an error.",
- "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "PENDING",
- "SETUP_DONE",
- "RUNNING",
- "CANCEL_PENDING",
- "CANCEL_STARTED",
- "CANCELLED",
- "DONE",
- "ERROR",
- "ATTEMPT_FAILURE"
- ],
- "description": "Required A state message specifying the overall job state.",
- "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"
- },
- "startTime": {
- "description": "The time when the server started the job.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "JobStatus"
- },
- "ClusterOperationStatus": {
- "description": "The status of the operation.",
- "type": "object",
- "properties": {
- "state": {
- "description": "Output-only. A message containing the operation state.",
- "type": "string",
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ],
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ]
- },
- "details": {
- "description": "Output-only.A message containing any operation metadata details.",
- "type": "string"
- },
- "innerState": {
- "description": "Output-only. A message containing the detailed operation state.",
- "type": "string"
- },
- "stateStartTime": {
- "description": "Output-only. The time this state was entered.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "ClusterOperationStatus"
+ "id": "PySparkJob"
}
},
- "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": "v1alpha1",
"baseUrl": "https://dataproc.googleapis.com/",
"auth": {
@@ -2072,11 +1400,683 @@
}
}
},
- "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",
+ "revision": "20170523",
+ "documentationLink": "https://cloud.google.com/dataproc/",
+ "id": "dataproc:v1alpha1",
+ "title": "Google Cloud Dataproc API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "resources": {
+ "operations": {
+ "methods": {
+ "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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The operation resource name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$"
+ }
+ },
+ "flatPath": "v1alpha1/operations/{operationsId}",
+ "path": "v1alpha1/{+name}",
+ "id": "dataproc.operations.get"
+ },
+ "list": {
+ "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.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "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",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The operation collection name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard List page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard List page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ }
+ },
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1alpha1/operations/{operationsId}:cancel",
+ "path": "v1alpha1/{+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 may use Operations.GetOperation or other methods to check whether the cancellation succeeded or the operation completed despite cancellation.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ }
+ },
+ "delete": {
+ "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.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "regions": {
+ "resources": {
+ "clusters": {
+ "methods": {
+ "delete": {
+ "description": "Request to delete a cluster in a project.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "DELETE",
+ "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": {
+ "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": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.delete"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "PATCH",
+ "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": {
+ "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",
+ "type": "string"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.patch",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Request to update a cluster in a project."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameters": {
+ "region": {
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "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."
+ },
+ "list": {
+ "description": "Request a list of all regions/{region}/clusters in a project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "region": {
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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": "v1alpha1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.list",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Required The 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 cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Request to create a cluster in a project."
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "list": {
+ "request": {
+ "$ref": "ListJobsRequest"
+ },
+ "description": "Lists regions/{region}/jobs in a project.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameters": {
+ "region": {
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs:list",
+ "id": "dataproc.projects.regions.jobs.list",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs:list"
+ },
+ "cancel": {
+ "request": {
+ "$ref": "CancelJobRequest"
+ },
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs:list or regions/{region}/jobs:get.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Required The 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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.get",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "description": "Gets the resource representation for a job in a project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "region": {
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required The job ID.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "patch": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Updates a job in a project.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "description": "Required The job ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Required Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.patch"
+ },
+ "submit": {
+ "description": "Submits a job to a cluster.",
+ "request": {
+ "$ref": "SubmitJobRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "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.",
+ "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",
+ "id": "dataproc.projects.regions.jobs.submit",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs:submit"
+ },
+ "delete": {
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.delete",
+ "path": "v1alpha1/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.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "description": "Required The job ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "$.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": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ }
+ }
}
diff --git a/dataproc/v1alpha1/dataproc-gen.go b/dataproc/v1alpha1/dataproc-gen.go
index 4d2d8ab..c2d548f 100644
--- a/dataproc/v1alpha1/dataproc-gen.go
+++ b/dataproc/v1alpha1/dataproc-gen.go
@@ -2020,7 +2020,7 @@
// 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
+// error detail types in the package google.rpc that can be used for
// common error conditions.Language mappingThe Status message is the
// logical representation of the error model, but it is not necessarily
// the actual wire format. When the Status message is exposed in
@@ -2035,7 +2035,7 @@
// 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.
+// have a Status message for error reporting.
// 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.
diff --git a/dataproc/v1beta1/dataproc-api.json b/dataproc/v1beta1/dataproc-api.json
index 8430a7c..696cbd1 100644
--- a/dataproc/v1beta1/dataproc-api.json
+++ b/dataproc/v1beta1/dataproc-api.json
@@ -1,25 +1,134 @@
{
+ "rootUrl": "https://dataproc.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "dataproc",
+ "batchPath": "batch",
+ "id": "dataproc:v1beta1",
+ "documentationLink": "https://cloud.google.com/dataproc/",
+ "revision": "20170523",
+ "title": "Google Cloud Dataproc API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"projects": {
"resources": {
"jobs": {
"methods": {
- "cancel": {
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call jobs.list or jobs.get.",
+ "submit": {
"request": {
- "$ref": "CancelJobRequest"
+ "$ref": "SubmitJobRequest"
},
+ "description": "Submits a job to a cluster.",
"httpMethod": "POST",
"parameterOrder": [
- "projectId",
- "jobId"
+ "projectId"
],
"response": {
"$ref": "Job"
},
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1beta1/projects/{projectId}/jobs:submit",
+ "id": "dataproc.projects.jobs.submit",
+ "path": "v1beta1/projects/{projectId}/jobs:submit"
+ },
+ "delete": {
+ "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "Required The job ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/jobs/{jobId}",
+ "path": "v1beta1/projects/{projectId}/jobs/{jobId}",
+ "id": "dataproc.projects.jobs.delete"
+ },
+ "list": {
+ "flatPath": "v1beta1/projects/{projectId}/jobs",
+ "path": "v1beta1/projects/{projectId}/jobs",
+ "id": "dataproc.projects.jobs.list",
+ "description": "Lists jobs in a project.",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Optional The number of results to return in each response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "clusterName": {
+ "description": "Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Optional A filter constraining 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"
+ },
+ "jobStateMatcher": {
+ "enum": [
+ "ALL",
+ "ACTIVE",
+ "NON_ACTIVE"
+ ],
+ "description": "Optional Specifies enumerated categories of jobs to list.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional The page token, returned by a previous call, to request the next page of results.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "cancel": {
"parameters": {
"projectId": {
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
@@ -34,15 +143,26 @@
"type": "string"
}
},
+ "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"
+ "path": "v1beta1/projects/{projectId}/jobs/{jobId}:cancel",
+ "request": {
+ "$ref": "CancelJobRequest"
+ },
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call jobs.list or jobs.get.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ }
},
"get": {
- "id": "dataproc.projects.jobs.get",
- "path": "v1beta1/projects/{projectId}/jobs/{jobId}",
- "description": "Gets the resource representation for a job in a project.",
- "httpMethod": "GET",
"response": {
"$ref": "Job"
},
@@ -50,12 +170,16 @@
"projectId",
"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",
- "location": "path"
+ "type": "string"
},
"jobId": {
"description": "Required The job ID.",
@@ -64,10 +188,10 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/jobs/{jobId}"
+ "flatPath": "v1beta1/projects/{projectId}/jobs/{jobId}",
+ "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",
@@ -83,16 +207,16 @@
],
"parameters": {
"updateMask": {
+ "location": "query",
"description": "Required Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
"format": "google-fieldmask",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"projectId": {
- "location": "path",
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"jobId": {
"location": "path",
@@ -108,270 +232,29 @@
"request": {
"$ref": "Job"
}
- },
- "submit": {
- "flatPath": "v1beta1/projects/{projectId}/jobs:submit",
- "path": "v1beta1/projects/{projectId}/jobs:submit",
- "id": "dataproc.projects.jobs.submit",
- "request": {
- "$ref": "SubmitJobRequest"
- },
- "description": "Submits a job to a cluster.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId"
- ],
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "Required The job ID.",
- "required": true,
- "type": "string"
- }
- },
- "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": {
- "flatPath": "v1beta1/projects/{projectId}/jobs",
- "id": "dataproc.projects.jobs.list",
- "path": "v1beta1/projects/{projectId}/jobs",
- "description": "Lists jobs in a project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListJobsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterName": {
- "description": "Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "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",
- "location": "query"
- },
- "jobStateMatcher": {
- "enum": [
- "ALL",
- "ACTIVE",
- "NON_ACTIVE"
- ],
- "description": "Optional Specifies enumerated categories of jobs to list.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Optional The page token, returned by a previous call, to request the next page of results."
- },
- "pageSize": {
- "location": "query",
- "description": "Optional The number of results to return in each response.",
- "format": "int32",
- "type": "integer"
- }
- }
}
}
},
"clusters": {
"methods": {
- "patch": {
- "id": "dataproc.projects.clusters.patch",
- "path": "v1beta1/projects/{projectId}/clusters/{clusterName}",
- "description": "Updates a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId",
- "clusterName"
- ],
- "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 the cluster belongs to.",
- "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\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"
- },
- "clusterName": {
- "description": "Required The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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",
- "parameterOrder": [
- "projectId",
- "clusterName"
- ],
- "response": {
- "$ref": "Cluster"
- },
- "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": {
- "id": "dataproc.projects.clusters.diagnose",
- "path": "v1beta1/projects/{projectId}/clusters/{clusterName}:diagnose",
- "request": {
- "$ref": "DiagnoseClusterRequest"
- },
- "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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}:diagnose"
- },
- "delete": {
- "httpMethod": "DELETE",
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to."
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/clusters/{clusterName}",
- "id": "dataproc.projects.clusters.delete",
- "path": "v1beta1/projects/{projectId}/clusters/{clusterName}",
- "description": "Deletes a cluster in a project."
- },
"list": {
+ "path": "v1beta1/projects/{projectId}/clusters",
+ "id": "dataproc.projects.clusters.list",
"description": "Lists all clusters in a project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
"response": {
"$ref": "ListClustersResponse"
},
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
"parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ },
"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",
@@ -387,35 +270,30 @@
"format": "int32",
"type": "integer",
"location": "query"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{projectId}/clusters",
- "id": "dataproc.projects.clusters.list",
- "path": "v1beta1/projects/{projectId}/clusters"
+ "flatPath": "v1beta1/projects/{projectId}/clusters"
},
"create": {
- "id": "dataproc.projects.clusters.create",
"path": "v1beta1/projects/{projectId}/clusters",
+ "id": "dataproc.projects.clusters.create",
+ "description": "Creates a cluster in a project.",
"request": {
"$ref": "Cluster"
},
- "description": "Creates a cluster in a project.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
"location": "path",
@@ -424,10 +302,143 @@
"type": "string"
}
},
+ "flatPath": "v1beta1/projects/{projectId}/clusters"
+ },
+ "get": {
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "projectId",
+ "clusterName"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{projectId}/clusters"
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterName": {
+ "description": "Required The cluster name.",
+ "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."
+ },
+ "patch": {
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Updates a cluster in a project.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "projectId",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project the cluster belongs to.",
+ "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\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"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/clusters/{clusterName}",
+ "id": "dataproc.projects.clusters.patch",
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "clusterName"
+ ],
+ "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"
+ },
+ "clusterName": {
+ "description": "Required The cluster name.",
+ "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"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "clusterName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "clusterName": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The cluster name."
+ },
+ "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.delete",
+ "description": "Deletes a cluster in a project."
}
}
}
@@ -435,8 +446,8 @@
},
"operations": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
+ "cancel": {
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
@@ -445,47 +456,79 @@
},
"parameters": {
"name": {
+ "pattern": "^operations/.+$",
"location": "path",
- "description": "The name of the operation resource to be deleted.",
+ "description": "The name of the operation resource to be cancelled.",
"required": true,
- "type": "string",
- "pattern": "^operations/.+$"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "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": {
- "response": {
- "$ref": "Operation"
+ "flatPath": "v1beta1/operations/{operationsId}:cancel",
+ "id": "dataproc.operations.cancel",
+ "path": "v1beta1/{+name}:cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
},
- "httpMethod": "GET",
+ "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": {
+ "response": {
+ "$ref": "Empty"
+ },
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
- "location": "path",
- "description": "The name of the operation resource.",
"required": true,
"type": "string",
- "pattern": "^operations/.+$"
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted."
}
},
"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."
+ "id": "dataproc.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."
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/operations/{operationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "dataproc.operations.get"
},
"list": {
+ "flatPath": "v1beta1/operations",
+ "id": "dataproc.operations.list",
+ "path": "v1beta1/{+name}",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.",
"httpMethod": "GET",
"parameterOrder": [
"name"
@@ -497,107 +540,38 @@
"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.",
+ "description": "The name of the operation's parent resource.",
"required": true,
"type": "string",
"pattern": "^operations$",
"location": "path"
},
"pageToken": {
- "location": "query",
"description": "The standard list page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
- "location": "query",
"description": "The standard list page size.",
"format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1beta1/operations",
- "id": "dataproc.operations.list",
- "path": "v1beta1/{+name}",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations."
- },
- "cancel": {
- "flatPath": "v1beta1/operations/{operationsId}:cancel",
- "path": "v1beta1/{+name}:cancel",
- "id": "dataproc.operations.cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. 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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
"type": "string",
- "pattern": "^operations/.+$"
+ "location": "query"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ }
}
}
}
},
"parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "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": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -609,14 +583,12 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "location": "query"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"access_token": {
"description": "OAuth access token.",
@@ -629,560 +601,91 @@
"type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
+ "type": "string",
+ "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."
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
}
},
"schemas": {
- "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",
- "items": {
- "type": "string"
- }
- },
- "pythonFileUris": {
- "description": "Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainPythonFileUri": {
- "description": "Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PySparkJob",
- "description": "A Cloud Dataproc job for running PySpark applications on YARN.",
- "type": "object"
- },
- "ClusterMetrics": {
- "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.",
- "type": "object",
- "properties": {
- "yarnMetrics": {
- "additionalProperties": {
- "type": "string",
- "format": "int64"
- },
- "description": "The YARN metrics.",
- "type": "object"
- },
- "hdfsMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The HDFS metrics.",
- "type": "object"
- }
- },
- "id": "ClusterMetrics"
- },
- "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",
- "items": {
- "$ref": "NodeInitializationAction"
- }
- },
- "softwareConfiguration": {
- "$ref": "SoftwareConfiguration",
- "description": "Optional The configuration settings for software inside the cluster."
- },
- "gceClusterConfiguration": {
- "$ref": "GceClusterConfiguration",
- "description": "Required 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, and then it will create and manage this project-level, per-location bucket for you.",
- "type": "string"
- },
- "masterConfiguration": {
- "$ref": "InstanceGroupConfiguration",
- "description": "Optional The Google Compute Engine configuration settings for the master instance in a cluster."
- },
- "secondaryWorkerConfiguration": {
- "$ref": "InstanceGroupConfiguration",
- "description": "Optional The Google Compute Engine configuration settings for additional worker instances in a cluster."
- }
- },
- "id": "ClusterConfiguration",
- "description": "The cluster configuration.",
- "type": "object"
- },
- "LoggingConfiguration": {
- "description": "The runtime logging configuration of the job.",
- "type": "object",
- "properties": {
- "driverLogLevels": {
- "additionalProperties": {
- "enum": [
- "LEVEL_UNSPECIFIED",
- "ALL",
- "TRACE",
- "DEBUG",
- "INFO",
- "WARN",
- "ERROR",
- "FATAL",
- "OFF"
- ],
- "type": "string"
- },
- "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
- "type": "object"
- }
- },
- "id": "LoggingConfiguration"
- },
- "InstanceGroupConfiguration": {
- "description": "The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
- "type": "object",
- "properties": {
- "accelerators": {
- "description": "Optional The Google Compute Engine accelerator configuration for these instances.",
- "type": "array",
- "items": {
- "$ref": "AcceleratorConfiguration"
- }
- },
- "numInstances": {
- "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"
- },
- "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.",
- "type": "string"
- },
- "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"
- },
- "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",
- "items": {
- "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."
- }
- },
- "id": "InstanceGroupConfiguration"
- },
- "GceClusterConfiguration": {
- "description": "Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
- "type": "object",
- "properties": {
- "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"
- },
- "description": "The Google Compute Engine metadata entries to add to all instances.",
- "type": "object"
- },
- "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",
- "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: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0.",
- "type": "string"
- }
- },
- "id": "GceClusterConfiguration"
- },
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
- },
- "DiagnoseClusterOutputLocation": {
- "id": "DiagnoseClusterOutputLocation",
- "description": "The location of diagnostic output.",
- "type": "object",
- "properties": {
- "outputUri": {
- "description": "Output-only The Google Cloud Storage URI of the diagnostic output. This is a plain text file with a summary of collected diagnostics.",
- "type": "string"
- }
- }
- },
- "Operation": {
- "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": {
- "type": "boolean",
- "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."
- },
- "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"
- }
- },
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object"
- },
- "OperationStatus": {
- "description": "The status of the operation.",
- "type": "object",
- "properties": {
- "state": {
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ],
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ],
- "description": "A message containing the operation state.",
- "type": "string"
- },
- "details": {
- "description": "A message containing any operation metadata details.",
- "type": "string"
- },
- "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"
- },
- "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": "Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
- "type": "string"
- }
- },
- "id": "JobReference"
- },
- "SubmitJobRequest": {
- "description": "A request to submit a job.",
- "type": "object",
- "properties": {
- "job": {
- "$ref": "Job",
- "description": "Required The job resource."
- }
- },
- "id": "SubmitJobRequest"
- },
- "Status": {
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc 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"
- }
- },
- "id": "Status"
- },
- "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"
- },
- "ListJobsResponse": {
- "description": "A list of jobs in a project.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Optional This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
- "type": "string"
- },
- "jobs": {
- "type": "array",
- "items": {
- "$ref": "Job"
- },
- "description": "Output-only Jobs list."
- }
- },
- "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": {
- "description": "Required Google Cloud Storage URI of executable file.",
- "type": "string"
- }
- },
- "id": "NodeInitializationAction"
- },
- "CancelJobRequest": {
- "description": "A request to cancel a job.",
- "type": "object",
- "properties": {},
- "id": "CancelJobRequest"
- },
- "SparkSqlJob": {
- "id": "SparkSqlJob",
- "description": "A Cloud Dataproc job for running Spark SQL queries.",
- "type": "object",
- "properties": {
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains SQL queries.",
- "type": "string"
- },
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
- "type": "object"
- },
- "jarFileUris": {
- "description": "Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.",
- "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 SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
- "type": "object"
- }
- }
- },
- "Cluster": {
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.",
- "type": "object"
- },
- "status": {
- "description": "Output-only Cluster status.",
- "$ref": "ClusterStatus"
- },
- "metrics": {
- "description": "Contains cluster daemon metrics such as HDFS and YARN stats.",
- "$ref": "ClusterMetrics"
- },
- "statusHistory": {
- "type": "array",
- "items": {
- "$ref": "ClusterStatus"
- },
- "description": "Output-only Previous cluster statuses."
- },
- "clusterName": {
- "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.",
- "type": "string"
- },
- "projectId": {
- "description": "Required The Google Cloud Platform project ID that the cluster belongs to.",
- "type": "string"
- },
- "configuration": {
- "description": "Required The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.",
- "$ref": "ClusterConfiguration"
- }
- },
- "id": "Cluster",
- "description": "Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances."
- },
"ListOperationsResponse": {
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"operations": {
- "description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Operation"
- }
+ },
+ "description": "A list of operations that matches the specified filter in the request."
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
"id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "description": "The response message for Operations.ListOperations."
},
"OperationMetadata": {
- "description": "Metadata describing the operation.",
"type": "object",
"properties": {
+ "operationType": {
+ "description": "Output-only The operation type.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Output-only Short description of operation.",
+ "type": "string"
+ },
"warnings": {
"description": "Output-only Errors encountered during operation execution.",
"type": "array",
@@ -1201,27 +704,19 @@
"$ref": "OperationStatus"
}
},
- "clusterUuid": {
- "description": "Cluster UUId for the operation.",
- "type": "string"
- },
"clusterName": {
"description": "Name of the cluster for the operation.",
"type": "string"
},
- "operationType": {
- "description": "Output-only The operation type.",
- "type": "string"
- },
- "description": {
- "description": "Output-only Short description of operation.",
- "type": "string"
+ "clusterUuid": {
+ "type": "string",
+ "description": "Cluster UUId for the operation."
}
},
- "id": "OperationMetadata"
+ "id": "OperationMetadata",
+ "description": "Metadata describing the operation."
},
"JobPlacement": {
- "id": "JobPlacement",
"description": "Cloud Dataproc job configuration.",
"type": "object",
"properties": {
@@ -1233,7 +728,8 @@
"description": "Output-only A cluster UUID generated by the Dataproc service when the job is submitted.",
"type": "string"
}
- }
+ },
+ "id": "JobPlacement"
},
"PigJob": {
"description": "A Cloud Dataproc job for running Pig queries on YARN.",
@@ -1248,46 +744,45 @@
"type": "string"
},
"queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
- "scriptVariables": {
- "description": "Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
+ "$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",
"items": {
"type": "string"
+ }
+ },
+ "scriptVariables": {
+ "additionalProperties": {
+ "type": "string"
},
- "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."
+ "description": "Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
+ "type": "object"
},
"loggingConfiguration": {
"$ref": "LoggingConfiguration",
"description": "Optional The runtime log configuration for job execution."
},
"properties": {
- "description": "Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
+ "type": "object"
}
},
"id": "PigJob"
},
"ClusterStatus": {
- "id": "ClusterStatus",
"description": "The status of a cluster and its instances.",
"type": "object",
"properties": {
"stateStartTime": {
- "type": "string",
"description": "Time when this state was entered.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"substate": {
"enum": [
@@ -1308,15 +803,6 @@
"type": "string"
},
"state": {
- "enum": [
- "UNKNOWN",
- "CREATING",
- "RUNNING",
- "ERROR",
- "DELETING",
- "UPDATING"
- ],
- "description": "The cluster's state.",
"type": "string",
"enumDescriptions": [
"The cluster state is unknown.",
@@ -1325,12 +811,21 @@
"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."
}
- }
+ },
+ "id": "ClusterStatus"
},
"AcceleratorConfiguration": {
- "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",
"properties": {
@@ -1339,14 +834,14 @@
"type": "string"
},
"acceleratorCount": {
- "type": "integer",
"description": "The number of the accelerator cards of this type exposed to this instance.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
- }
+ },
+ "id": "AcceleratorConfiguration"
},
"ManagedGroupConfiguration": {
- "description": "Specifies the resources used to actively manage an instance group.",
"type": "object",
"properties": {
"instanceGroupManagerName": {
@@ -1358,7 +853,8 @@
"type": "string"
}
},
- "id": "ManagedGroupConfiguration"
+ "id": "ManagedGroupConfiguration",
+ "description": "Specifies the resources used to actively manage an instance group."
},
"ListClustersResponse": {
"id": "ListClustersResponse",
@@ -1366,11 +862,11 @@
"type": "object",
"properties": {
"clusters": {
- "description": "Output-only The clusters in the project.",
"type": "array",
"items": {
"$ref": "Cluster"
- }
+ },
+ "description": "Output-only The clusters in the project."
},
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -1378,80 +874,10 @@
}
}
},
- "SparkJob": {
- "properties": {
- "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"
- },
- "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"
- }
- }
- },
- "id": "SparkJob",
- "description": "A Cloud Dataproc job for running Spark applications on YARN.",
- "type": "object"
- },
"Job": {
"description": "A Cloud Dataproc job resource.",
"type": "object",
"properties": {
- "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": {
- "description": "Job is a Pig job.",
- "$ref": "PigJob"
- },
"hiveJob": {
"description": "Job is a Hive job.",
"$ref": "HiveJob"
@@ -1494,8 +920,8 @@
"$ref": "PySparkJob"
},
"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"
+ "$ref": "JobReference",
+ "description": "Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e."
},
"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.",
@@ -1509,43 +935,94 @@
"$ref": "HadoopJob",
"description": "Job is a Hadoop job."
},
+ "status": {
+ "$ref": "JobStatus",
+ "description": "Output-only The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields."
+ },
"placement": {
"$ref": "JobPlacement",
"description": "Required Job information, including how, when, and where to run the job."
},
- "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": {
+ "description": "Job is a Pig job.",
+ "$ref": "PigJob"
}
},
"id": "Job"
},
+ "SparkJob": {
+ "description": "A Cloud Dataproc job for running Spark applications on YARN.",
+ "type": "object",
+ "properties": {
+ "jarFileUris": {
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
+ "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"
+ },
"JobStatus": {
"description": "Cloud Dataproc job status.",
"type": "object",
"properties": {
- "stateStartTime": {
- "type": "string",
- "description": "Output-only The time when this state was entered.",
- "format": "google-datetime"
- },
- "substate": {
- "enumDescriptions": [
- "",
- "The Job is submitted to the agent.Applies to RUNNING state.",
- "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
- "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
- ],
- "enum": [
- "UNSPECIFIED",
- "SUBMITTED",
- "QUEUED",
- "STALE_STATUS"
- ],
- "description": "Output-only Additional state information, which includes status reported by the agent.",
- "type": "string"
- },
"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.",
@@ -1569,18 +1046,39 @@
"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"
+ },
+ "substate": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "The Job is submitted to the agent.Applies to RUNNING state.",
+ "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
+ "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "SUBMITTED",
+ "QUEUED",
+ "STALE_STATUS"
+ ],
+ "description": "Output-only Additional state information, which includes status reported by the agent."
}
},
"id": "JobStatus"
},
"DiskConfiguration": {
+ "description": "Specifies the configuration of disk options for a group of VM instances.",
+ "type": "object",
"properties": {
"numLocalSsds": {
"description": "Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS 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.",
@@ -1593,12 +1091,9 @@
"type": "integer"
}
},
- "id": "DiskConfiguration",
- "description": "Specifies the configuration of disk options for a group of VM instances.",
- "type": "object"
+ "id": "DiskConfiguration"
},
"ClusterOperationStatus": {
- "id": "ClusterOperationStatus",
"description": "The status of the operation.",
"type": "object",
"properties": {
@@ -1628,15 +1123,101 @@
"type": "string"
},
"details": {
- "type": "string",
- "description": "Output-only.A message containing any operation metadata details."
+ "description": "Output-only.A message containing any operation metadata details.",
+ "type": "string"
}
- }
+ },
+ "id": "ClusterOperationStatus"
+ },
+ "YarnApplication": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "NEW",
+ "NEW_SAVING",
+ "SUBMITTED",
+ "ACCEPTED",
+ "RUNNING",
+ "FINISHED",
+ "FAILED",
+ "KILLED"
+ ],
+ "description": "Required The application state.",
+ "type": "string",
+ "enumDescriptions": [
+ "Status is unspecified.",
+ "Status is NEW.",
+ "Status is NEW_SAVING.",
+ "Status is SUBMITTED.",
+ "Status is ACCEPTED.",
+ "Status is RUNNING.",
+ "Status is FINISHED.",
+ "Status is FAILED.",
+ "Status is KILLED."
+ ]
+ },
+ "name": {
+ "description": "Required The application name.",
+ "type": "string"
+ },
+ "trackingUrl": {
+ "description": "Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
+ "type": "string"
+ },
+ "progress": {
+ "description": "Required The numerical progress of the application, from 1 to 100.",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "YarnApplication",
+ "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e."
+ },
+ "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",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "QueryList"
},
"HadoopJob": {
"description": "A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN.",
"type": "object",
"properties": {
+ "loggingConfiguration": {
+ "$ref": "LoggingConfiguration",
+ "description": "Optional The runtime log configuration for job execution."
+ },
+ "properties": {
+ "description": "Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "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 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"
@@ -1658,108 +1239,20 @@
"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 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 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"
- }
}
},
"id": "HadoopJob"
},
- "QueryList": {
- "description": "A list of queries to run on a cluster.",
- "type": "object",
- "properties": {
- "queries": {
- "description": "Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "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",
- "NEW_SAVING",
- "SUBMITTED",
- "ACCEPTED",
- "RUNNING",
- "FINISHED",
- "FAILED",
- "KILLED"
- ],
- "description": "Required The application state.",
- "type": "string"
- },
- "name": {
- "description": "Required The application name.",
- "type": "string"
- },
- "trackingUrl": {
- "description": "Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
- "type": "string"
- },
- "progress": {
- "description": "Required The numerical progress of the application, from 1 to 100.",
- "format": "float",
- "type": "number"
- }
- },
- "id": "YarnApplication"
- },
"DiagnoseClusterRequest": {
- "properties": {},
- "id": "DiagnoseClusterRequest",
"description": "A request to collect cluster diagnostic information.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "DiagnoseClusterRequest"
},
"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"
@@ -1772,37 +1265,63 @@
}
},
"labels": {
+ "description": "Output-only. Labels associated with the operation",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Output-only. Labels associated with the operation",
- "type": "object"
+ }
},
"status": {
- "description": "Output-only. Current operation status.",
- "$ref": "ClusterOperationStatus"
+ "$ref": "ClusterOperationStatus",
+ "description": "Output-only. Current operation status."
},
"statusHistory": {
- "description": "Output-only. The previous operation status.",
"type": "array",
"items": {
"$ref": "ClusterOperationStatus"
- }
+ },
+ "description": "Output-only. The previous operation status."
+ },
+ "clusterUuid": {
+ "description": "Output-only. Cluster UUID for the operation.",
+ "type": "string"
},
"clusterName": {
"description": "Output-only. Name of the cluster for the operation.",
"type": "string"
},
- "clusterUuid": {
- "description": "Output-only. Cluster UUID for the operation.",
+ "operationType": {
+ "description": "Output-only. The operation type.",
"type": "string"
}
},
- "id": "ClusterOperationMetadata",
- "description": "Metadata describing the operation."
+ "id": "ClusterOperationMetadata"
},
"HiveJob": {
+ "description": "A Cloud Dataproc job for running Hive queries on YARN.",
+ "type": "object",
"properties": {
+ "scriptVariables": {
+ "description": "Optional Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
+ "type": "object",
+ "additionalProperties": {
+ "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"
+ }
+ },
+ "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"
@@ -1814,32 +1333,9 @@
"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"
- },
- "description": "Optional Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
- "type": "object"
- },
- "properties": {
- "description": "Optional A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
}
},
- "id": "HiveJob",
- "description": "A Cloud Dataproc job for running Hive queries on YARN.",
- "type": "object"
+ "id": "HiveJob"
},
"Empty": {
"properties": {},
@@ -1852,35 +1348,550 @@
"type": "object",
"properties": {
"outputUri": {
- "description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.",
- "type": "string"
+ "type": "string",
+ "description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics."
}
},
"id": "DiagnoseClusterResults"
},
"SoftwareConfiguration": {
- "description": "Specifies the selection and configuration of software inside the cluster.",
"type": "object",
"properties": {
- "properties": {
- "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"
- },
"imageVersion": {
"description": "Optional The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).",
"type": "string"
+ },
+ "properties": {
+ "description": "Optional The properties to set on daemon 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"
+ }
}
},
- "id": "SoftwareConfiguration"
+ "id": "SoftwareConfiguration",
+ "description": "Specifies the selection and configuration of software inside the cluster."
+ },
+ "PySparkJob": {
+ "description": "A Cloud Dataproc job for running PySpark applications on YARN.",
+ "type": "object",
+ "properties": {
+ "args": {
+ "description": "Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "fileUris": {
+ "description": "Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "pythonFileUris": {
+ "description": "Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mainPythonFileUri": {
+ "description": "Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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 PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object"
+ }
+ },
+ "id": "PySparkJob"
+ },
+ "LoggingConfiguration": {
+ "id": "LoggingConfiguration",
+ "description": "The runtime logging configuration of the job.",
+ "type": "object",
+ "properties": {
+ "driverLogLevels": {
+ "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "enum": [
+ "LEVEL_UNSPECIFIED",
+ "ALL",
+ "TRACE",
+ "DEBUG",
+ "INFO",
+ "WARN",
+ "ERROR",
+ "FATAL",
+ "OFF"
+ ]
+ }
+ }
+ }
+ },
+ "ClusterMetrics": {
+ "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.",
+ "type": "object",
+ "properties": {
+ "hdfsMetrics": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "The HDFS metrics.",
+ "type": "object"
+ },
+ "yarnMetrics": {
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "The YARN metrics."
+ }
+ },
+ "id": "ClusterMetrics"
+ },
+ "ClusterConfiguration": {
+ "id": "ClusterConfiguration",
+ "description": "The cluster configuration.",
+ "type": "object",
+ "properties": {
+ "secondaryWorkerConfiguration": {
+ "$ref": "InstanceGroupConfiguration",
+ "description": "Optional The Google Compute Engine configuration settings for additional 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",
+ "items": {
+ "$ref": "NodeInitializationAction"
+ }
+ },
+ "workerConfiguration": {
+ "$ref": "InstanceGroupConfiguration",
+ "description": "Optional The Google Compute Engine configuration settings for worker instances in a cluster."
+ },
+ "gceClusterConfiguration": {
+ "description": "Required The shared Google Compute Engine configuration settings for all instances in a cluster.",
+ "$ref": "GceClusterConfiguration"
+ },
+ "softwareConfiguration": {
+ "$ref": "SoftwareConfiguration",
+ "description": "Optional The configuration settings for software inside the 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, and then it will create and manage this project-level, per-location bucket for you.",
+ "type": "string"
+ },
+ "masterConfiguration": {
+ "$ref": "InstanceGroupConfiguration",
+ "description": "Optional The Google Compute Engine configuration settings for the master instance in a cluster."
+ }
+ }
+ },
+ "InstanceGroupConfiguration": {
+ "description": "The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
+ "type": "object",
+ "properties": {
+ "numInstances": {
+ "description": "The number of VM instances in the instance group. For master instance groups, must be set to 1.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "diskConfiguration": {
+ "$ref": "DiskConfiguration",
+ "description": "Disk option configuration settings."
+ },
+ "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"
+ },
+ "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.",
+ "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"
+ },
+ "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",
+ "items": {
+ "type": "string"
+ }
+ },
+ "accelerators": {
+ "description": "Optional The Google Compute Engine accelerator configuration for these instances.",
+ "type": "array",
+ "items": {
+ "$ref": "AcceleratorConfiguration"
+ }
+ }
+ },
+ "id": "InstanceGroupConfiguration"
+ },
+ "GceClusterConfiguration": {
+ "id": "GceClusterConfiguration",
+ "description": "Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "type": "object",
+ "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"
+ },
+ "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 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",
+ "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"
+ }
+ }
+ },
+ "CancelOperationRequest": {
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {}
+ },
+ "DiagnoseClusterOutputLocation": {
+ "description": "The location of diagnostic output.",
+ "type": "object",
+ "properties": {
+ "outputUri": {
+ "description": "Output-only The Google Cloud Storage URI of the diagnostic output. This is a plain text file with a summary of collected diagnostics.",
+ "type": "string"
+ }
+ },
+ "id": "DiagnoseClusterOutputLocation"
+ },
+ "Operation": {
+ "properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object"
+ },
+ "OperationStatus": {
+ "description": "The status of the operation.",
+ "type": "object",
+ "properties": {
+ "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 running.",
+ "The operation is done; either cancelled or completed."
+ ]
+ },
+ "details": {
+ "description": "A message containing any operation metadata details.",
+ "type": "string"
+ },
+ "innerState": {
+ "type": "string",
+ "description": "A message containing the detailed operation state."
+ },
+ "stateStartTime": {
+ "description": "The time this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "OperationStatus"
+ },
+ "JobReference": {
+ "properties": {
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string"
+ },
+ "jobId": {
+ "description": "Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
+ "type": "string"
+ }
+ },
+ "id": "JobReference",
+ "description": "Encapsulates the full scoping used to reference a job.",
+ "type": "object"
+ },
+ "SubmitJobRequest": {
+ "type": "object",
+ "properties": {
+ "job": {
+ "$ref": "Job",
+ "description": "Required The job resource."
+ }
+ },
+ "id": "SubmitJobRequest",
+ "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 that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There 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"
+ }
+ }
+ },
+ "id": "Status"
+ },
+ "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"
+ },
+ "ListJobsResponse": {
+ "description": "A list of jobs in a project.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ },
+ "CancelJobRequest": {
+ "description": "A request to cancel a job.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelJobRequest"
+ },
+ "SparkSqlJob": {
+ "description": "A Cloud Dataproc job for running Spark SQL queries.",
+ "type": "object",
+ "properties": {
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains SQL queries.",
+ "type": "string"
+ },
+ "scriptVariables": {
+ "description": "Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "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": {
+ "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"
+ },
+ "Cluster": {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.",
+ "type": "object"
+ },
+ "metrics": {
+ "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"
+ }
+ },
+ "clusterName": {
+ "type": "string",
+ "description": "Required The cluster name. Cluster names within a project must be unique. Names from 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"
+ },
+ "configuration": {
+ "$ref": "ClusterConfiguration",
+ "description": "Required The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated."
+ }
+ },
+ "id": "Cluster",
+ "description": "Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances."
}
},
"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": "v1beta1",
"baseUrl": "https://dataproc.googleapis.com/",
@@ -1893,18 +1904,7 @@
}
}
},
- "kind": "discovery#restDescription",
- "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
"servicePath": "",
- "rootUrl": "https://dataproc.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "dataproc",
- "batchPath": "batch",
- "revision": "20170502",
- "documentationLink": "https://cloud.google.com/dataproc/",
- "id": "dataproc:v1beta1",
- "title": "Google Cloud Dataproc API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+ "kind": "discovery#restDescription"
}
diff --git a/dataproc/v1beta1/dataproc-gen.go b/dataproc/v1beta1/dataproc-gen.go
index 7672738..35988dc 100644
--- a/dataproc/v1beta1/dataproc-gen.go
+++ b/dataproc/v1beta1/dataproc-gen.go
@@ -1845,7 +1845,7 @@
// 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
+// error detail types in the package google.rpc that can be used for
// common error conditions.Language mappingThe Status message is the
// logical representation of the error model, but it is not necessarily
// the actual wire format. When the Status message is exposed in
@@ -1860,7 +1860,7 @@
// 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.
+// have a Status message for error reporting.
// 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.
@@ -2564,7 +2564,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "path",
// "pattern": "^operations$",
// "required": true,
diff --git a/datastore/v1/datastore-api.json b/datastore/v1/datastore-api.json
index b3bb2e9..f70e136 100644
--- a/datastore/v1/datastore-api.json
+++ b/datastore/v1/datastore-api.json
@@ -1,9 +1,11 @@
{
+ "basePath": "",
+ "ownerDomain": "google.com",
"name": "datastore",
"batchPath": "batch",
"id": "datastore:v1",
"documentationLink": "https://cloud.google.com/datastore/",
- "revision": "20170502",
+ "revision": "20170523",
"title": "Google Cloud Datastore API",
"ownerName": "Google",
"discoveryVersion": "v1",
@@ -11,41 +13,13 @@
"resources": {
"projects": {
"methods": {
- "runQuery": {
- "response": {
- "$ref": "RunQueryResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1/projects/{projectId}:runQuery",
- "path": "v1/projects/{projectId}:runQuery",
- "id": "datastore.projects.runQuery",
+ "allocateIds": {
"request": {
- "$ref": "RunQueryRequest"
+ "$ref": "AllocateIdsRequest"
},
- "description": "Queries for entities."
- },
- "rollback": {
- "request": {
- "$ref": "RollbackRequest"
- },
- "description": "Rolls back a transaction.",
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
"response": {
- "$ref": "RollbackResponse"
+ "$ref": "AllocateIdsResponse"
},
"parameterOrder": [
"projectId"
@@ -63,65 +37,9 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1/projects/{projectId}:rollback",
- "path": "v1/projects/{projectId}:rollback",
- "id": "datastore.projects.rollback"
- },
- "lookup": {
- "description": "Looks up entities by key.",
- "request": {
- "$ref": "LookupRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "LookupResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}:lookup",
- "id": "datastore.projects.lookup",
- "path": "v1/projects/{projectId}:lookup"
- },
- "allocateIds": {
- "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
- "request": {
- "$ref": "AllocateIdsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "AllocateIdsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
"flatPath": "v1/projects/{projectId}:allocateIds",
- "id": "datastore.projects.allocateIds",
- "path": "v1/projects/{projectId}:allocateIds"
+ "path": "v1/projects/{projectId}:allocateIds",
+ "id": "datastore.projects.allocateIds"
},
"commit": {
"flatPath": "v1/projects/{projectId}:commit",
@@ -144,32 +62,109 @@
],
"parameters": {
"projectId": {
+ "description": "The ID of the project against which to make the request.",
"required": true,
"type": "string",
- "location": "path",
- "description": "The ID of the project against which to make the request."
+ "location": "path"
}
}
},
"beginTransaction": {
+ "response": {
+ "$ref": "BeginTransactionResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
"flatPath": "v1/projects/{projectId}:beginTransaction",
- "id": "datastore.projects.beginTransaction",
"path": "v1/projects/{projectId}:beginTransaction",
+ "id": "datastore.projects.beginTransaction",
"description": "Begins a new transaction.",
"request": {
"$ref": "BeginTransactionRequest"
+ }
+ },
+ "runQuery": {
+ "response": {
+ "$ref": "RunQueryResponse"
},
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}:runQuery",
+ "path": "v1/projects/{projectId}:runQuery",
+ "id": "datastore.projects.runQuery",
+ "description": "Queries for entities.",
+ "request": {
+ "$ref": "RunQueryRequest"
+ }
+ },
+ "rollback": {
"httpMethod": "POST",
"parameterOrder": [
"projectId"
],
"response": {
- "$ref": "BeginTransactionResponse"
+ "$ref": "RollbackResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
+ "flatPath": "v1/projects/{projectId}:rollback",
+ "id": "datastore.projects.rollback",
+ "path": "v1/projects/{projectId}:rollback",
+ "request": {
+ "$ref": "RollbackRequest"
+ },
+ "description": "Rolls back a transaction."
+ },
+ "lookup": {
+ "request": {
+ "$ref": "LookupRequest"
+ },
+ "description": "Looks up entities by key.",
+ "response": {
+ "$ref": "LookupResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"projectId": {
"description": "The ID of the project against which to make the request.",
@@ -177,66 +172,41 @@
"type": "string",
"location": "path"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1/projects/{projectId}:lookup",
+ "path": "v1/projects/{projectId}:lookup",
+ "id": "datastore.projects.lookup"
}
}
}
},
"parameters": {
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "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": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -246,7 +216,8 @@
"1",
"2"
],
- "description": "V1 error format."
+ "description": "V1 error format.",
+ "type": "string"
},
"callback": {
"location": "query",
@@ -254,9 +225,6 @@
"type": "string"
},
"alt": {
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -267,18 +235,503 @@
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
- ]
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"schemas": {
+ "Filter": {
+ "properties": {
+ "propertyFilter": {
+ "$ref": "PropertyFilter",
+ "description": "A filter on a property."
+ },
+ "compositeFilter": {
+ "description": "A composite filter.",
+ "$ref": "CompositeFilter"
+ }
+ },
+ "id": "Filter",
+ "description": "A holder for any type of filter.",
+ "type": "object"
+ },
+ "RollbackRequest": {
+ "description": "The request for Datastore.Rollback.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "RollbackRequest"
+ },
+ "RunQueryRequest": {
+ "description": "The request for Datastore.RunQuery.",
+ "type": "object",
+ "properties": {
+ "partitionId": {
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID."
+ },
+ "gqlQuery": {
+ "$ref": "GqlQuery",
+ "description": "The GQL query to run."
+ },
+ "readOptions": {
+ "description": "The options for this query.",
+ "$ref": "ReadOptions"
+ },
+ "query": {
+ "description": "The query to run.",
+ "$ref": "Query"
+ }
+ },
+ "id": "RunQueryRequest"
+ },
+ "CompositeFilter": {
+ "properties": {
+ "filters": {
+ "description": "The list of filters to combine.\nMust contain at least one filter.",
+ "type": "array",
+ "items": {
+ "$ref": "Filter"
+ }
+ },
+ "op": {
+ "description": "The operator for combining multiple filters.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "The results are required to satisfy each of the combined filters."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "AND"
+ ]
+ }
+ },
+ "id": "CompositeFilter",
+ "description": "A filter that merges multiple other filters using the given operator.",
+ "type": "object"
+ },
+ "AllocateIdsResponse": {
+ "properties": {
+ "keys": {
+ "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
+ }
+ },
+ "id": "AllocateIdsResponse",
+ "description": "The response for Datastore.AllocateIds.",
+ "type": "object"
+ },
+ "Query": {
+ "description": "A query for entities.",
+ "type": "object",
+ "properties": {
+ "projection": {
+ "description": "The projection to return. Defaults to returning all properties.",
+ "type": "array",
+ "items": {
+ "$ref": "Projection"
+ }
+ },
+ "endCursor": {
+ "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
+ "format": "byte",
+ "type": "string"
+ },
+ "filter": {
+ "$ref": "Filter",
+ "description": "The filter to apply."
+ },
+ "limit": {
+ "description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be \u003e= 0 if specified.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "offset": {
+ "description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startCursor": {
+ "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
+ "format": "byte",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified.",
+ "type": "array",
+ "items": {
+ "$ref": "KindExpression"
+ }
+ },
+ "distinctOn": {
+ "description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
+ "type": "array",
+ "items": {
+ "$ref": "PropertyReference"
+ }
+ },
+ "order": {
+ "description": "The order to apply to the query results (if empty, order is unspecified).",
+ "type": "array",
+ "items": {
+ "$ref": "PropertyOrder"
+ }
+ }
+ },
+ "id": "Query"
+ },
+ "PropertyFilter": {
+ "description": "A filter on a specific property.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "$ref": "Value",
+ "description": "The value to compare the property to."
+ },
+ "property": {
+ "description": "The property to filter by.",
+ "$ref": "PropertyReference"
+ },
+ "op": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Less than.",
+ "Less than or equal.",
+ "Greater than.",
+ "Greater than or equal.",
+ "Equal.",
+ "Has ancestor."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "LESS_THAN",
+ "LESS_THAN_OR_EQUAL",
+ "GREATER_THAN",
+ "GREATER_THAN_OR_EQUAL",
+ "EQUAL",
+ "HAS_ANCESTOR"
+ ],
+ "description": "The operator to filter by.",
+ "type": "string"
+ }
+ },
+ "id": "PropertyFilter"
+ },
+ "EntityResult": {
+ "properties": {
+ "entity": {
+ "description": "The resulting entity.",
+ "$ref": "Entity"
+ },
+ "cursor": {
+ "description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the entity, a strictly positive number that monotonically\nincreases with changes to the entity.\n\nThis field is set for `FULL` entity\nresults.\n\nFor missing entities in `LookupResponse`, this\nis the version of the snapshot that was used to look up the entity, and it\nis always set except for eventually consistent reads.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "EntityResult",
+ "description": "The result of fetching an entity from Datastore.",
+ "type": "object"
+ },
+ "CommitResponse": {
+ "description": "The response for Datastore.Commit.",
+ "type": "object",
+ "properties": {
+ "mutationResults": {
+ "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "MutationResult"
+ }
+ },
+ "indexUpdates": {
+ "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "CommitResponse"
+ },
+ "Value": {
+ "description": "A message that can hold any of the supported value types and associated\nmetadata.",
+ "type": "object",
+ "properties": {
+ "excludeFromIndexes": {
+ "description": "If the value should be excluded from all indexes including those defined\nexplicitly.",
+ "type": "boolean"
+ },
+ "doubleValue": {
+ "description": "A double value.",
+ "format": "double",
+ "type": "number"
+ },
+ "timestampValue": {
+ "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "booleanValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ },
+ "nullValue": {
+ "description": "A null value.",
+ "type": "string",
+ "enumDescriptions": [
+ "Null value."
+ ],
+ "enum": [
+ "NULL_VALUE"
+ ]
+ },
+ "blobValue": {
+ "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
+ "format": "byte",
+ "type": "string"
+ },
+ "meaning": {
+ "description": "The `meaning` field should only be populated for backwards compatibility.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "arrayValue": {
+ "$ref": "ArrayValue",
+ "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`."
+ },
+ "entityValue": {
+ "$ref": "Entity",
+ "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key."
+ },
+ "geoPointValue": {
+ "$ref": "LatLng",
+ "description": "A geo point value representing a point on the surface of Earth."
+ },
+ "keyValue": {
+ "description": "A key value.",
+ "$ref": "Key"
+ },
+ "integerValue": {
+ "description": "An integer value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "stringValue": {
+ "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
+ "type": "string"
+ }
+ },
+ "id": "Value"
+ },
+ "PartitionId": {
+ "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\nForeign partition IDs (in which the project ID does\nnot match the context project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.",
+ "type": "object",
+ "properties": {
+ "namespaceId": {
+ "description": "If not empty, the ID of the namespace to which the entities belong.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the project to which the entities belong.",
+ "type": "string"
+ }
+ },
+ "id": "PartitionId"
+ },
+ "Entity": {
+ "description": "A Datastore data object.\n\nAn entity is limited to 1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for the serialized form of this\nmessage.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "additionalProperties": {
+ "$ref": "Value"
+ },
+ "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
+ "type": "object"
+ },
+ "key": {
+ "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key.",
+ "$ref": "Key"
+ }
+ },
+ "id": "Entity"
+ },
+ "LookupRequest": {
+ "description": "The request for Datastore.Lookup.",
+ "type": "object",
+ "properties": {
+ "readOptions": {
+ "$ref": "ReadOptions",
+ "description": "The options for this lookup request."
+ },
+ "keys": {
+ "description": "Keys of entities to look up.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
+ }
+ },
+ "id": "LookupRequest"
+ },
+ "QueryResultBatch": {
+ "description": "A batch of results produced by a query.",
+ "type": "object",
+ "properties": {
+ "moreResults": {
+ "enum": [
+ "MORE_RESULTS_TYPE_UNSPECIFIED",
+ "NOT_FINISHED",
+ "MORE_RESULTS_AFTER_LIMIT",
+ "MORE_RESULTS_AFTER_CURSOR",
+ "NO_MORE_RESULTS"
+ ],
+ "description": "The state of the query after the current batch.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value is never used.",
+ "There may be additional batches to fetch from this query.",
+ "The query is finished, but there may be more results after the limit.",
+ "The query is finished, but there may be more results after the end\ncursor.",
+ "The query has been exhausted."
+ ]
+ },
+ "endCursor": {
+ "description": "A cursor that points to the position after the last result in the batch.",
+ "format": "byte",
+ "type": "string"
+ },
+ "snapshotVersion": {
+ "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
+ "format": "int64",
+ "type": "string"
+ },
+ "skippedCursor": {
+ "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
+ "format": "byte",
+ "type": "string"
+ },
+ "skippedResults": {
+ "description": "The number of results skipped, typically because of an offset.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "entityResultType": {
+ "enumDescriptions": [
+ "Unspecified. This value is never used.",
+ "The key and properties.",
+ "A projected subset of properties. The entity may have no key.",
+ "Only the key."
+ ],
+ "enum": [
+ "RESULT_TYPE_UNSPECIFIED",
+ "FULL",
+ "PROJECTION",
+ "KEY_ONLY"
+ ],
+ "description": "The result type for every entity in `entity_results`.",
+ "type": "string"
+ },
+ "entityResults": {
+ "description": "The results for this batch.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityResult"
+ }
+ }
+ },
+ "id": "QueryResultBatch"
+ },
+ "PathElement": {
+ "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "PathElement"
+ },
+ "GqlQueryParameter": {
+ "properties": {
+ "cursor": {
+ "description": "A query cursor. Query cursors are returned in query\nresult batches.",
+ "format": "byte",
+ "type": "string"
+ },
+ "value": {
+ "$ref": "Value",
+ "description": "A value parameter."
+ }
+ },
+ "id": "GqlQueryParameter",
+ "description": "A binding parameter for a GQL query.",
+ "type": "object"
+ },
"BeginTransactionResponse": {
"description": "The response for Datastore.BeginTransaction.",
"type": "object",
"properties": {
"transaction": {
- "type": "string",
"description": "The transaction identifier (always present).",
- "format": "byte"
+ "format": "byte",
+ "type": "string"
}
},
"id": "BeginTransactionResponse"
@@ -301,13 +754,6 @@
"description": "The response for Datastore.Lookup.",
"type": "object",
"properties": {
- "deferred": {
- "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
- "type": "array",
- "items": {
- "$ref": "Key"
- }
- },
"found": {
"description": "Entities found as `ResultType.FULL` entities. The order of results in this\nfield is undefined and has no relation to the order of the keys in the\ninput.",
"type": "array",
@@ -321,6 +767,13 @@
"items": {
"$ref": "EntityResult"
}
+ },
+ "deferred": {
+ "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
}
},
"id": "LookupResponse"
@@ -334,13 +787,21 @@
"description": "The parsed form of the `GqlQuery` from the request, if it was set."
},
"batch": {
- "description": "A batch of query results (always present).",
- "$ref": "QueryResultBatch"
+ "$ref": "QueryResultBatch",
+ "description": "A batch of query results (always present)."
}
},
"id": "RunQueryResponse"
},
+ "BeginTransactionRequest": {
+ "description": "The request for Datastore.BeginTransaction.",
+ "type": "object",
+ "properties": {},
+ "id": "BeginTransactionRequest"
+ },
"CommitRequest": {
+ "description": "The request for Datastore.Commit.",
+ "type": "object",
"properties": {
"mutations": {
"description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
@@ -369,27 +830,15 @@
]
}
},
- "id": "CommitRequest",
- "description": "The request for Datastore.Commit.",
- "type": "object"
- },
- "BeginTransactionRequest": {
- "description": "The request for Datastore.BeginTransaction.",
- "type": "object",
- "properties": {},
- "id": "BeginTransactionRequest"
+ "id": "CommitRequest"
},
"PropertyOrder": {
- "description": "The desired order for a specific property.",
- "type": "object",
"properties": {
"property": {
- "$ref": "PropertyReference",
- "description": "The property to order by."
+ "description": "The property to order by.",
+ "$ref": "PropertyReference"
},
"direction": {
- "description": "The direction to order by. Defaults to `ASCENDING`.",
- "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Ascending.",
@@ -399,10 +848,14 @@
"DIRECTION_UNSPECIFIED",
"ASCENDING",
"DESCENDING"
- ]
+ ],
+ "description": "The direction to order by. Defaults to `ASCENDING`.",
+ "type": "string"
}
},
- "id": "PropertyOrder"
+ "id": "PropertyOrder",
+ "description": "The desired order for a specific property.",
+ "type": "object"
},
"KindExpression": {
"properties": {
@@ -415,6 +868,23 @@
"description": "A representation of a kind.",
"type": "object"
},
+ "LatLng": {
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object",
+ "properties": {
+ "latitude": {
+ "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"
+ },
"Key": {
"description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
"type": "object",
@@ -427,29 +897,12 @@
}
},
"partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.",
+ "$ref": "PartitionId"
}
},
"id": "Key"
},
- "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].",
- "format": "double",
- "type": "number"
- },
- "latitude": {
- "type": "number",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "format": "double"
- }
- },
- "id": "LatLng"
- },
"PropertyReference": {
"description": "A reference to a property relative to the kind expressions.",
"type": "object",
@@ -462,15 +915,15 @@
"id": "PropertyReference"
},
"Projection": {
+ "description": "A representation of a property in a projection.",
+ "type": "object",
"properties": {
"property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
+ "description": "The property to project.",
+ "$ref": "PropertyReference"
}
},
- "id": "Projection",
- "description": "A representation of a property in a projection.",
- "type": "object"
+ "id": "Projection"
},
"ArrayValue": {
"description": "An array value.",
@@ -487,20 +940,14 @@
"id": "ArrayValue"
},
"Mutation": {
- "description": "A mutation to apply to an entity.",
- "type": "object",
"properties": {
- "upsert": {
- "$ref": "Entity",
- "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete."
- },
"delete": {
- "$ref": "Key",
- "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only."
+ "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only.",
+ "$ref": "Key"
},
"insert": {
- "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete.",
- "$ref": "Entity"
+ "$ref": "Entity",
+ "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete."
},
"baseVersion": {
"description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
@@ -508,37 +955,43 @@
"type": "string"
},
"update": {
- "description": "The entity to update. The entity must already exist.\nMust have a complete key path.",
+ "$ref": "Entity",
+ "description": "The entity to update. The entity must already exist.\nMust have a complete key path."
+ },
+ "upsert": {
+ "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete.",
"$ref": "Entity"
}
},
- "id": "Mutation"
+ "id": "Mutation",
+ "description": "A mutation to apply to an entity.",
+ "type": "object"
},
"ReadOptions": {
- "id": "ReadOptions",
"description": "The options shared by read requests.",
"type": "object",
"properties": {
"readConsistency": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Strong consistency.",
+ "Eventual consistency."
+ ],
"enum": [
"READ_CONSISTENCY_UNSPECIFIED",
"STRONG",
"EVENTUAL"
],
"description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Strong consistency.",
- "Eventual consistency."
- ]
+ "type": "string"
},
"transaction": {
"description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
"format": "byte",
"type": "string"
}
- }
+ },
+ "id": "ReadOptions"
},
"RollbackResponse": {
"description": "The response for Datastore.Rollback.\n(an empty message).",
@@ -550,10 +1003,6 @@
"description": "The result of applying a mutation.",
"type": "object",
"properties": {
- "key": {
- "description": "The automatically allocated key.\nSet only when the mutation allocated a key.",
- "$ref": "Key"
- },
"version": {
"description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
"format": "int64",
@@ -562,6 +1011,10 @@
"conflictDetected": {
"description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
"type": "boolean"
+ },
+ "key": {
+ "$ref": "Key",
+ "description": "The automatically allocated key.\nSet only when the mutation allocated a key."
}
},
"id": "MutationResult"
@@ -579,11 +1032,11 @@
"type": "boolean"
},
"namedBindings": {
- "description": "For each non-reserved named binding site in the query string, there must be\na named parameter with that name, but not necessarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`__.*__`, and must not be `\"\"`.",
- "type": "object",
"additionalProperties": {
"$ref": "GqlQueryParameter"
- }
+ },
+ "description": "For each non-reserved named binding site in the query string, there must be\na named parameter with that name, but not necessarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`__.*__`, and must not be `\"\"`.",
+ "type": "object"
},
"positionalBindings": {
"description": "Numbered binding site @1 references the first numbered parameter,\neffectively using 1-based indexing, rather than the usual 0.\n\nFor each binding site numbered i in `query_string`, there must be an i-th\nnumbered parameter. The inverse must also be true.",
@@ -594,457 +1047,6 @@
}
},
"id": "GqlQuery"
- },
- "Filter": {
- "description": "A holder for any type of filter.",
- "type": "object",
- "properties": {
- "propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
- },
- "compositeFilter": {
- "description": "A composite filter.",
- "$ref": "CompositeFilter"
- }
- },
- "id": "Filter"
- },
- "RollbackRequest": {
- "description": "The request for Datastore.Rollback.",
- "type": "object",
- "properties": {
- "transaction": {
- "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "RollbackRequest"
- },
- "RunQueryRequest": {
- "description": "The request for Datastore.RunQuery.",
- "type": "object",
- "properties": {
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this query."
- },
- "query": {
- "description": "The query to run.",
- "$ref": "Query"
- },
- "partitionId": {
- "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID.",
- "$ref": "PartitionId"
- },
- "gqlQuery": {
- "description": "The GQL query to run.",
- "$ref": "GqlQuery"
- }
- },
- "id": "RunQueryRequest"
- },
- "CompositeFilter": {
- "description": "A filter that merges multiple other filters using the given operator.",
- "type": "object",
- "properties": {
- "filters": {
- "description": "The list of filters to combine.\nMust contain at least one filter.",
- "type": "array",
- "items": {
- "$ref": "Filter"
- }
- },
- "op": {
- "description": "The operator for combining multiple filters.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "The results are required to satisfy each of the combined filters."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "AND"
- ]
- }
- },
- "id": "CompositeFilter"
- },
- "AllocateIdsResponse": {
- "type": "object",
- "properties": {
- "keys": {
- "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.",
- "type": "array",
- "items": {
- "$ref": "Key"
- }
- }
- },
- "id": "AllocateIdsResponse",
- "description": "The response for Datastore.AllocateIds."
- },
- "Query": {
- "type": "object",
- "properties": {
- "kind": {
- "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified.",
- "type": "array",
- "items": {
- "$ref": "KindExpression"
- }
- },
- "distinctOn": {
- "description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
- "type": "array",
- "items": {
- "$ref": "PropertyReference"
- }
- },
- "order": {
- "description": "The order to apply to the query results (if empty, order is unspecified).",
- "type": "array",
- "items": {
- "$ref": "PropertyOrder"
- }
- },
- "projection": {
- "description": "The projection to return. Defaults to returning all properties.",
- "type": "array",
- "items": {
- "$ref": "Projection"
- }
- },
- "endCursor": {
- "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
- "format": "byte",
- "type": "string"
- },
- "filter": {
- "$ref": "Filter",
- "description": "The filter to apply."
- },
- "limit": {
- "description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be \u003e= 0 if specified.",
- "format": "int32",
- "type": "integer"
- },
- "startCursor": {
- "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
- "format": "byte",
- "type": "string"
- },
- "offset": {
- "description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Query",
- "description": "A query for entities."
- },
- "PropertyFilter": {
- "description": "A filter on a specific property.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The value to compare the property to.",
- "$ref": "Value"
- },
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to filter by."
- },
- "op": {
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "LESS_THAN",
- "LESS_THAN_OR_EQUAL",
- "GREATER_THAN",
- "GREATER_THAN_OR_EQUAL",
- "EQUAL",
- "HAS_ANCESTOR"
- ],
- "description": "The operator to filter by.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Less than.",
- "Less than or equal.",
- "Greater than.",
- "Greater than or equal.",
- "Equal.",
- "Has ancestor."
- ]
- }
- },
- "id": "PropertyFilter"
- },
- "EntityResult": {
- "description": "The result of fetching an entity from Datastore.",
- "type": "object",
- "properties": {
- "cursor": {
- "description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "The version of the entity, a strictly positive number that monotonically\nincreases with changes to the entity.\n\nThis field is set for `FULL` entity\nresults.\n\nFor missing entities in `LookupResponse`, this\nis the version of the snapshot that was used to look up the entity, and it\nis always set except for eventually consistent reads.",
- "format": "int64",
- "type": "string"
- },
- "entity": {
- "description": "The resulting entity.",
- "$ref": "Entity"
- }
- },
- "id": "EntityResult"
- },
- "Value": {
- "description": "A message that can hold any of the supported value types and associated\nmetadata.",
- "type": "object",
- "properties": {
- "blobValue": {
- "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
- "format": "byte",
- "type": "string"
- },
- "meaning": {
- "description": "The `meaning` field should only be populated for backwards compatibility.",
- "format": "int32",
- "type": "integer"
- },
- "arrayValue": {
- "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`.",
- "$ref": "ArrayValue"
- },
- "entityValue": {
- "$ref": "Entity",
- "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key."
- },
- "geoPointValue": {
- "description": "A geo point value representing a point on the surface of Earth.",
- "$ref": "LatLng"
- },
- "integerValue": {
- "type": "string",
- "description": "An integer value.",
- "format": "int64"
- },
- "keyValue": {
- "description": "A key value.",
- "$ref": "Key"
- },
- "stringValue": {
- "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
- "type": "string"
- },
- "excludeFromIndexes": {
- "description": "If the value should be excluded from all indexes including those defined\nexplicitly.",
- "type": "boolean"
- },
- "doubleValue": {
- "description": "A double value.",
- "format": "double",
- "type": "number"
- },
- "timestampValue": {
- "type": "string",
- "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
- "format": "google-datetime"
- },
- "nullValue": {
- "enumDescriptions": [
- "Null value."
- ],
- "enum": [
- "NULL_VALUE"
- ],
- "description": "A null value.",
- "type": "string"
- },
- "booleanValue": {
- "description": "A boolean value.",
- "type": "boolean"
- }
- },
- "id": "Value"
- },
- "CommitResponse": {
- "properties": {
- "indexUpdates": {
- "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "mutationResults": {
- "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
- "type": "array",
- "items": {
- "$ref": "MutationResult"
- }
- }
- },
- "id": "CommitResponse",
- "description": "The response for Datastore.Commit.",
- "type": "object"
- },
- "PartitionId": {
- "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\nForeign partition IDs (in which the project ID does\nnot match the context project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "The ID of the project to which the entities belong.",
- "type": "string"
- },
- "namespaceId": {
- "description": "If not empty, the ID of the namespace to which the entities belong.",
- "type": "string"
- }
- },
- "id": "PartitionId"
- },
- "Entity": {
- "id": "Entity",
- "description": "A Datastore data object.\n\nAn entity is limited to 1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for the serialized form of this\nmessage.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
- "type": "object",
- "additionalProperties": {
- "$ref": "Value"
- }
- },
- "key": {
- "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key.",
- "$ref": "Key"
- }
- }
- },
- "QueryResultBatch": {
- "description": "A batch of results produced by a query.",
- "type": "object",
- "properties": {
- "entityResults": {
- "description": "The results for this batch.",
- "type": "array",
- "items": {
- "$ref": "EntityResult"
- }
- },
- "endCursor": {
- "description": "A cursor that points to the position after the last result in the batch.",
- "format": "byte",
- "type": "string"
- },
- "moreResults": {
- "description": "The state of the query after the current batch.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value is never used.",
- "There may be additional batches to fetch from this query.",
- "The query is finished, but there may be more results after the limit.",
- "The query is finished, but there may be more results after the end\ncursor.",
- "The query has been exhausted."
- ],
- "enum": [
- "MORE_RESULTS_TYPE_UNSPECIFIED",
- "NOT_FINISHED",
- "MORE_RESULTS_AFTER_LIMIT",
- "MORE_RESULTS_AFTER_CURSOR",
- "NO_MORE_RESULTS"
- ]
- },
- "snapshotVersion": {
- "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
- "format": "int64",
- "type": "string"
- },
- "skippedCursor": {
- "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
- "format": "byte",
- "type": "string"
- },
- "skippedResults": {
- "type": "integer",
- "description": "The number of results skipped, typically because of an offset.",
- "format": "int32"
- },
- "entityResultType": {
- "description": "The result type for every entity in `entity_results`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value is never used.",
- "The key and properties.",
- "A projected subset of properties. The entity may have no key.",
- "Only the key."
- ],
- "enum": [
- "RESULT_TYPE_UNSPECIFIED",
- "FULL",
- "PROJECTION",
- "KEY_ONLY"
- ]
- }
- },
- "id": "QueryResultBatch"
- },
- "LookupRequest": {
- "type": "object",
- "properties": {
- "keys": {
- "type": "array",
- "items": {
- "$ref": "Key"
- },
- "description": "Keys of entities to look up."
- },
- "readOptions": {
- "description": "The options for this lookup request.",
- "$ref": "ReadOptions"
- }
- },
- "id": "LookupRequest",
- "description": "The request for Datastore.Lookup."
- },
- "PathElement": {
- "properties": {
- "id": {
- "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- }
- },
- "id": "PathElement",
- "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
- "type": "object"
- },
- "GqlQueryParameter": {
- "description": "A binding parameter for a GQL query.",
- "type": "object",
- "properties": {
- "cursor": {
- "description": "A query cursor. Query cursors are returned in query\nresult batches.",
- "format": "byte",
- "type": "string"
- },
- "value": {
- "description": "A value parameter.",
- "$ref": "Value"
- }
- },
- "id": "GqlQueryParameter"
}
},
"icons": {
@@ -1066,10 +1068,8 @@
}
}
},
- "kind": "discovery#restDescription",
"description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
+ "kind": "discovery#restDescription",
"servicePath": "",
- "rootUrl": "https://datastore.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com"
+ "rootUrl": "https://datastore.googleapis.com/"
}
diff --git a/datastore/v1/datastore-gen.go b/datastore/v1/datastore-gen.go
index 89f0cdb..dc3f54e 100644
--- a/datastore/v1/datastore-gen.go
+++ b/datastore/v1/datastore-gen.go
@@ -710,10 +710,6 @@
// 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].
diff --git a/datastore/v1beta3/datastore-api.json b/datastore/v1beta3/datastore-api.json
index 65cb44c..3652f07 100644
--- a/datastore/v1beta3/datastore-api.json
+++ b/datastore/v1beta3/datastore-api.json
@@ -1,43 +1,39 @@
{
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": "True",
"resources": {
"projects": {
"methods": {
- "beginTransaction": {
- "flatPath": "v1beta3/projects/{projectId}:beginTransaction",
- "id": "datastore.projects.beginTransaction",
- "path": "v1beta3/projects/{projectId}:beginTransaction",
- "request": {
- "$ref": "BeginTransactionRequest"
+ "allocateIds": {
+ "response": {
+ "$ref": "AllocateIdsResponse"
},
- "description": "Begins a new transaction.",
- "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "response": {
- "$ref": "BeginTransactionResponse"
- },
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
- ]
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta3/projects/{projectId}:allocateIds",
+ "path": "v1beta3/projects/{projectId}:allocateIds",
+ "id": "datastore.projects.allocateIds",
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
+ "request": {
+ "$ref": "AllocateIdsRequest"
+ }
},
"commit": {
- "id": "datastore.projects.commit",
- "path": "v1beta3/projects/{projectId}:commit",
- "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
- "request": {
- "$ref": "CommitRequest"
- },
"httpMethod": "POST",
"parameterOrder": [
"projectId"
@@ -51,15 +47,53 @@
],
"parameters": {
"projectId": {
+ "description": "The ID of the project against which to make the request.",
"required": true,
"type": "string",
- "location": "path",
- "description": "The ID of the project against which to make the request."
+ "location": "path"
}
},
- "flatPath": "v1beta3/projects/{projectId}:commit"
+ "flatPath": "v1beta3/projects/{projectId}:commit",
+ "id": "datastore.projects.commit",
+ "path": "v1beta3/projects/{projectId}:commit",
+ "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
+ "request": {
+ "$ref": "CommitRequest"
+ }
+ },
+ "beginTransaction": {
+ "response": {
+ "$ref": "BeginTransactionResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta3/projects/{projectId}:beginTransaction",
+ "path": "v1beta3/projects/{projectId}:beginTransaction",
+ "id": "datastore.projects.beginTransaction",
+ "description": "Begins a new transaction.",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ }
},
"runQuery": {
+ "description": "Queries for entities.",
+ "request": {
+ "$ref": "RunQueryRequest"
+ },
"httpMethod": "POST",
"parameterOrder": [
"projectId"
@@ -67,27 +101,27 @@
"response": {
"$ref": "RunQueryResponse"
},
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
+ "parameters": {
+ "projectId": {
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
"flatPath": "v1beta3/projects/{projectId}:runQuery",
"id": "datastore.projects.runQuery",
- "path": "v1beta3/projects/{projectId}:runQuery",
- "request": {
- "$ref": "RunQueryRequest"
- },
- "description": "Queries for entities."
+ "path": "v1beta3/projects/{projectId}:runQuery"
},
"rollback": {
+ "request": {
+ "$ref": "RollbackRequest"
+ },
+ "description": "Rolls back a transaction.",
"response": {
"$ref": "RollbackResponse"
},
@@ -109,13 +143,13 @@
],
"flatPath": "v1beta3/projects/{projectId}:rollback",
"path": "v1beta3/projects/{projectId}:rollback",
- "id": "datastore.projects.rollback",
- "request": {
- "$ref": "RollbackRequest"
- },
- "description": "Rolls back a transaction."
+ "id": "datastore.projects.rollback"
},
"lookup": {
+ "description": "Looks up entities by key.",
+ "request": {
+ "$ref": "LookupRequest"
+ },
"httpMethod": "POST",
"parameterOrder": [
"projectId"
@@ -137,39 +171,7 @@
},
"flatPath": "v1beta3/projects/{projectId}:lookup",
"id": "datastore.projects.lookup",
- "path": "v1beta3/projects/{projectId}:lookup",
- "description": "Looks up entities by key.",
- "request": {
- "$ref": "LookupRequest"
- }
- },
- "allocateIds": {
- "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
- "request": {
- "$ref": "AllocateIdsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "AllocateIdsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta3/projects/{projectId}:allocateIds",
- "id": "datastore.projects.allocateIds",
- "path": "v1beta3/projects/{projectId}:allocateIds"
+ "path": "v1beta3/projects/{projectId}:lookup"
}
}
}
@@ -186,21 +188,21 @@
"type": "boolean",
"default": "true"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
- "upload_protocol": {
+ "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.",
@@ -208,16 +210,23 @@
"default": "true"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -226,21 +235,9 @@
"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",
@@ -249,21 +246,133 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
}
},
"schemas": {
+ "RollbackResponse": {
+ "properties": {},
+ "id": "RollbackResponse",
+ "description": "The response for Datastore.Rollback.\n(an empty message).",
+ "type": "object"
+ },
+ "MutationResult": {
+ "properties": {
+ "conflictDetected": {
+ "description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
+ "type": "boolean"
+ },
+ "key": {
+ "$ref": "Key",
+ "description": "The automatically allocated key.\nSet only when the mutation allocated a key."
+ },
+ "version": {
+ "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "MutationResult",
+ "description": "The result of applying a mutation.",
+ "type": "object"
+ },
+ "GqlQuery": {
+ "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "object",
+ "properties": {
+ "queryString": {
+ "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "string"
+ },
+ "allowLiterals": {
+ "description": "When false, the query string must not contain any literals and instead must\nbind all values. For example,\n`SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE a = @value` is.",
+ "type": "boolean"
+ },
+ "namedBindings": {
+ "additionalProperties": {
+ "$ref": "GqlQueryParameter"
+ },
+ "description": "For each non-reserved named binding site in the query string, there must be\na named parameter with that name, but not necessarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`__.*__`, and must not be `\"\"`.",
+ "type": "object"
+ },
+ "positionalBindings": {
+ "description": "Numbered binding site @1 references the first numbered parameter,\neffectively using 1-based indexing, rather than the usual 0.\n\nFor each binding site numbered i in `query_string`, there must be an i-th\nnumbered parameter. The inverse must also be true.",
+ "type": "array",
+ "items": {
+ "$ref": "GqlQueryParameter"
+ }
+ }
+ },
+ "id": "GqlQuery"
+ },
+ "Filter": {
+ "properties": {
+ "compositeFilter": {
+ "description": "A composite filter.",
+ "$ref": "CompositeFilter"
+ },
+ "propertyFilter": {
+ "$ref": "PropertyFilter",
+ "description": "A filter on a property."
+ }
+ },
+ "id": "Filter",
+ "description": "A holder for any type of filter.",
+ "type": "object"
+ },
+ "RollbackRequest": {
+ "description": "The request for Datastore.Rollback.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "RollbackRequest"
+ },
+ "RunQueryRequest": {
+ "description": "The request for Datastore.RunQuery.",
+ "type": "object",
+ "properties": {
+ "partitionId": {
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID."
+ },
+ "gqlQuery": {
+ "$ref": "GqlQuery",
+ "description": "The GQL query to run."
+ },
+ "readOptions": {
+ "$ref": "ReadOptions",
+ "description": "The options for this query."
+ },
+ "query": {
+ "$ref": "Query",
+ "description": "The query to run."
+ }
+ },
+ "id": "RunQueryRequest"
+ },
"CompositeFilter": {
+ "description": "A filter that merges multiple other filters using the given operator.",
+ "type": "object",
"properties": {
"filters": {
"description": "The list of filters to combine.\nMust contain at least one filter.",
@@ -273,6 +382,8 @@
}
},
"op": {
+ "description": "The operator for combining multiple filters.",
+ "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"The results are required to satisfy each of the combined filters."
@@ -280,19 +391,12 @@
"enum": [
"OPERATOR_UNSPECIFIED",
"AND"
- ],
- "description": "The operator for combining multiple filters.",
- "type": "string"
+ ]
}
},
- "id": "CompositeFilter",
- "description": "A filter that merges multiple other filters using the given operator.",
- "type": "object"
+ "id": "CompositeFilter"
},
"AllocateIdsResponse": {
- "id": "AllocateIdsResponse",
- "description": "The response for Datastore.AllocateIds.",
- "type": "object",
"properties": {
"keys": {
"description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.",
@@ -301,10 +405,22 @@
"$ref": "Key"
}
}
- }
+ },
+ "id": "AllocateIdsResponse",
+ "description": "The response for Datastore.AllocateIds.",
+ "type": "object"
},
"Query": {
+ "description": "A query for entities.",
+ "type": "object",
"properties": {
+ "projection": {
+ "description": "The projection to return. Defaults to returning all properties.",
+ "type": "array",
+ "items": {
+ "$ref": "Projection"
+ }
+ },
"endCursor": {
"description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"format": "byte",
@@ -320,9 +436,9 @@
"type": "integer"
},
"offset": {
- "type": "integer",
"description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"startCursor": {
"description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
@@ -344,32 +460,37 @@
}
},
"order": {
+ "description": "The order to apply to the query results (if empty, order is unspecified).",
"type": "array",
"items": {
"$ref": "PropertyOrder"
- },
- "description": "The order to apply to the query results (if empty, order is unspecified)."
- },
- "projection": {
- "description": "The projection to return. Defaults to returning all properties.",
- "type": "array",
- "items": {
- "$ref": "Projection"
}
}
},
- "id": "Query",
- "description": "A query for entities.",
- "type": "object"
+ "id": "Query"
},
"PropertyFilter": {
+ "description": "A filter on a specific property.",
"type": "object",
"properties": {
+ "value": {
+ "description": "The value to compare the property to.",
+ "$ref": "Value"
+ },
"property": {
- "$ref": "PropertyReference",
- "description": "The property to filter by."
+ "description": "The property to filter by.",
+ "$ref": "PropertyReference"
},
"op": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Less than.",
+ "Less than or equal.",
+ "Greater than.",
+ "Greater than or equal.",
+ "Equal.",
+ "Has ancestor."
+ ],
"enum": [
"OPERATOR_UNSPECIFIED",
"LESS_THAN",
@@ -380,27 +501,12 @@
"HAS_ANCESTOR"
],
"description": "The operator to filter by.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Less than.",
- "Less than or equal.",
- "Greater than.",
- "Greater than or equal.",
- "Equal.",
- "Has ancestor."
- ]
- },
- "value": {
- "description": "The value to compare the property to.",
- "$ref": "Value"
+ "type": "string"
}
},
- "id": "PropertyFilter",
- "description": "A filter on a specific property."
+ "id": "PropertyFilter"
},
"EntityResult": {
- "id": "EntityResult",
"description": "The result of fetching an entity from Datastore.",
"type": "object",
"properties": {
@@ -415,55 +521,47 @@
"type": "string"
},
"entity": {
- "description": "The resulting entity.",
- "$ref": "Entity"
- }
- }
- },
- "CommitResponse": {
- "type": "object",
- "properties": {
- "indexUpdates": {
- "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "mutationResults": {
- "type": "array",
- "items": {
- "$ref": "MutationResult"
- },
- "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request."
+ "$ref": "Entity",
+ "description": "The resulting entity."
}
},
- "id": "CommitResponse",
- "description": "The response for Datastore.Commit."
+ "id": "EntityResult"
},
"Value": {
"description": "A message that can hold any of the supported value types and associated\nmetadata.",
"type": "object",
"properties": {
+ "blobValue": {
+ "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
+ "format": "byte",
+ "type": "string"
+ },
+ "meaning": {
+ "description": "The `meaning` field should only be populated for backwards compatibility.",
+ "format": "int32",
+ "type": "integer"
+ },
"arrayValue": {
- "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`.",
- "$ref": "ArrayValue"
+ "$ref": "ArrayValue",
+ "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`."
},
"entityValue": {
"$ref": "Entity",
"description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key."
},
"geoPointValue": {
- "description": "A geo point value representing a point on the surface of Earth.",
- "$ref": "LatLng"
+ "$ref": "LatLng",
+ "description": "A geo point value representing a point on the surface of Earth."
+ },
+ "keyValue": {
+ "$ref": "Key",
+ "description": "A key value."
},
"integerValue": {
"description": "An integer value.",
"format": "int64",
"type": "string"
},
- "keyValue": {
- "description": "A key value.",
- "$ref": "Key"
- },
"stringValue": {
"description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
"type": "string"
@@ -487,39 +585,48 @@
"type": "boolean"
},
"nullValue": {
- "description": "A null value.",
- "type": "string",
"enumDescriptions": [
"Null value."
],
"enum": [
"NULL_VALUE"
- ]
- },
- "blobValue": {
- "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
- "format": "byte",
+ ],
+ "description": "A null value.",
"type": "string"
- },
- "meaning": {
- "description": "The `meaning` field should only be populated for backwards compatibility.",
- "format": "int32",
- "type": "integer"
}
},
"id": "Value"
},
+ "CommitResponse": {
+ "properties": {
+ "indexUpdates": {
+ "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "mutationResults": {
+ "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "MutationResult"
+ }
+ }
+ },
+ "id": "CommitResponse",
+ "description": "The response for Datastore.Commit.",
+ "type": "object"
+ },
"PartitionId": {
"description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\nForeign partition IDs (in which the project ID does\nnot match the context project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.",
"type": "object",
"properties": {
- "namespaceId": {
- "description": "If not empty, the ID of the namespace to which the entities belong.",
- "type": "string"
- },
"projectId": {
"description": "The ID of the project to which the entities belong.",
"type": "string"
+ },
+ "namespaceId": {
+ "description": "If not empty, the ID of the namespace to which the entities belong.",
+ "type": "string"
}
},
"id": "PartitionId"
@@ -533,76 +640,22 @@
"description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key."
},
"properties": {
- "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
- "type": "object",
"additionalProperties": {
"$ref": "Value"
- }
+ },
+ "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
+ "type": "object"
}
},
"id": "Entity"
},
- "LookupRequest": {
- "description": "The request for Datastore.Lookup.",
- "type": "object",
- "properties": {
- "keys": {
- "description": "Keys of entities to look up.",
- "type": "array",
- "items": {
- "$ref": "Key"
- }
- },
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this lookup request."
- }
- },
- "id": "LookupRequest"
- },
"QueryResultBatch": {
"description": "A batch of results produced by a query.",
"type": "object",
"properties": {
- "moreResults": {
- "enum": [
- "MORE_RESULTS_TYPE_UNSPECIFIED",
- "NOT_FINISHED",
- "MORE_RESULTS_AFTER_LIMIT",
- "MORE_RESULTS_AFTER_CURSOR",
- "NO_MORE_RESULTS"
- ],
- "description": "The state of the query after the current batch.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value is never used.",
- "There may be additional batches to fetch from this query.",
- "The query is finished, but there may be more results after the limit.",
- "The query is finished, but there may be more results after the end\ncursor.",
- "The query has been exhausted."
- ]
- },
- "endCursor": {
- "description": "A cursor that points to the position after the last result in the batch.",
- "format": "byte",
- "type": "string"
- },
- "snapshotVersion": {
- "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
- "format": "int64",
- "type": "string"
- },
- "skippedCursor": {
- "type": "string",
- "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
- "format": "byte"
- },
- "skippedResults": {
- "description": "The number of results skipped, typically because of an offset.",
- "format": "int32",
- "type": "integer"
- },
"entityResultType": {
+ "description": "The result type for every entity in `entity_results`.",
+ "type": "string",
"enumDescriptions": [
"Unspecified. This value is never used.",
"The key and properties.",
@@ -614,9 +667,7 @@
"FULL",
"PROJECTION",
"KEY_ONLY"
- ],
- "description": "The result type for every entity in `entity_results`.",
- "type": "string"
+ ]
},
"entityResults": {
"description": "The results for this batch.",
@@ -624,14 +675,72 @@
"items": {
"$ref": "EntityResult"
}
+ },
+ "endCursor": {
+ "description": "A cursor that points to the position after the last result in the batch.",
+ "format": "byte",
+ "type": "string"
+ },
+ "moreResults": {
+ "description": "The state of the query after the current batch.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value is never used.",
+ "There may be additional batches to fetch from this query.",
+ "The query is finished, but there may be more results after the limit.",
+ "The query is finished, but there may be more results after the end\ncursor.",
+ "The query has been exhausted."
+ ],
+ "enum": [
+ "MORE_RESULTS_TYPE_UNSPECIFIED",
+ "NOT_FINISHED",
+ "MORE_RESULTS_AFTER_LIMIT",
+ "MORE_RESULTS_AFTER_CURSOR",
+ "NO_MORE_RESULTS"
+ ]
+ },
+ "snapshotVersion": {
+ "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
+ "format": "int64",
+ "type": "string"
+ },
+ "skippedCursor": {
+ "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
+ "format": "byte",
+ "type": "string"
+ },
+ "skippedResults": {
+ "description": "The number of results skipped, typically because of an offset.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "QueryResultBatch"
},
- "PathElement": {
- "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
+ "LookupRequest": {
+ "description": "The request for Datastore.Lookup.",
"type": "object",
"properties": {
+ "readOptions": {
+ "description": "The options for this lookup request.",
+ "$ref": "ReadOptions"
+ },
+ "keys": {
+ "description": "Keys of entities to look up.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
+ }
+ },
+ "id": "LookupRequest"
+ },
+ "PathElement": {
+ "properties": {
+ "name": {
+ "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
"kind": {
"description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
"type": "string"
@@ -640,26 +749,24 @@
"description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
"format": "int64",
"type": "string"
- },
- "name": {
- "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
}
},
- "id": "PathElement"
+ "id": "PathElement",
+ "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
+ "type": "object"
},
"GqlQueryParameter": {
"description": "A binding parameter for a GQL query.",
"type": "object",
"properties": {
- "value": {
- "$ref": "Value",
- "description": "A value parameter."
- },
"cursor": {
"description": "A query cursor. Query cursors are returned in query\nresult batches.",
"format": "byte",
"type": "string"
+ },
+ "value": {
+ "$ref": "Value",
+ "description": "A value parameter."
}
},
"id": "GqlQueryParameter"
@@ -719,38 +826,61 @@
"id": "LookupResponse"
},
"RunQueryResponse": {
+ "description": "The response for Datastore.RunQuery.",
"type": "object",
"properties": {
+ "query": {
+ "$ref": "Query",
+ "description": "The parsed form of the `GqlQuery` from the request, if it was set."
+ },
"batch": {
"description": "A batch of query results (always present).",
"$ref": "QueryResultBatch"
- },
- "query": {
- "description": "The parsed form of the `GqlQuery` from the request, if it was set.",
- "$ref": "Query"
}
},
- "id": "RunQueryResponse",
- "description": "The response for Datastore.RunQuery."
+ "id": "RunQueryResponse"
+ },
+ "BeginTransactionRequest": {
+ "properties": {},
+ "id": "BeginTransactionRequest",
+ "description": "The request for Datastore.BeginTransaction.",
+ "type": "object"
+ },
+ "PropertyOrder": {
+ "description": "The desired order for a specific property.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "description": "The property to order by.",
+ "$ref": "PropertyReference"
+ },
+ "direction": {
+ "description": "The direction to order by. Defaults to `ASCENDING`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Ascending.",
+ "Descending."
+ ],
+ "enum": [
+ "DIRECTION_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ]
+ }
+ },
+ "id": "PropertyOrder"
},
"CommitRequest": {
"description": "The request for Datastore.Commit.",
"type": "object",
"properties": {
- "mutations": {
- "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
- "type": "array",
- "items": {
- "$ref": "Mutation"
- }
- },
"transaction": {
"description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
"format": "byte",
"type": "string"
},
"mode": {
- "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
@@ -761,61 +891,56 @@
"TRANSACTIONAL",
"NON_TRANSACTIONAL"
],
- "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`."
+ "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
+ "type": "string"
+ },
+ "mutations": {
+ "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
+ "type": "array",
+ "items": {
+ "$ref": "Mutation"
+ }
}
},
"id": "CommitRequest"
},
- "BeginTransactionRequest": {
- "description": "The request for Datastore.BeginTransaction.",
- "type": "object",
- "properties": {},
- "id": "BeginTransactionRequest"
- },
- "PropertyOrder": {
- "description": "The desired order for a specific property.",
- "type": "object",
- "properties": {
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to order by."
- },
- "direction": {
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Ascending.",
- "Descending."
- ],
- "enum": [
- "DIRECTION_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The direction to order by. Defaults to `ASCENDING`.",
- "type": "string"
- }
- },
- "id": "PropertyOrder"
- },
"KindExpression": {
- "description": "A representation of a kind.",
- "type": "object",
"properties": {
"name": {
"description": "The name of the kind.",
"type": "string"
}
},
- "id": "KindExpression"
+ "id": "KindExpression",
+ "description": "A representation of a kind.",
+ "type": "object"
+ },
+ "Key": {
+ "description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nAn entity path is always fully complete: *all* of the entity's ancestors\nare required to be in the path along with the entity identifier itself.\nThe only exception is that in some documented cases, the identifier in the\nlast path element (for the entity) itself may be omitted. For example,\nthe last path element of the key of `Mutation.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can have at most 100 elements.",
+ "type": "array",
+ "items": {
+ "$ref": "PathElement"
+ }
+ },
+ "partitionId": {
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
+ }
+ },
+ "id": "Key"
},
"LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\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.",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
"type": "object",
"properties": {
"longitude": {
- "type": "number",
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "format": "double"
+ "format": "double",
+ "type": "number"
},
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
@@ -825,24 +950,6 @@
},
"id": "LatLng"
},
- "Key": {
- "description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
- "type": "object",
- "properties": {
- "partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
- },
- "path": {
- "description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nAn entity path is always fully complete: *all* of the entity's ancestors\nare required to be in the path along with the entity identifier itself.\nThe only exception is that in some documented cases, the identifier in the\nlast path element (for the entity) itself may be omitted. For example,\nthe last path element of the key of `Mutation.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can have at most 100 elements.",
- "type": "array",
- "items": {
- "$ref": "PathElement"
- }
- }
- },
- "id": "Key"
- },
"PropertyReference": {
"description": "A reference to a property relative to the kind expressions.",
"type": "object",
@@ -854,7 +961,20 @@
},
"id": "PropertyReference"
},
+ "Projection": {
+ "description": "A representation of a property in a projection.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "description": "The property to project.",
+ "$ref": "PropertyReference"
+ }
+ },
+ "id": "Projection"
+ },
"ArrayValue": {
+ "description": "An array value.",
+ "type": "object",
"properties": {
"values": {
"description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
@@ -864,33 +984,15 @@
}
}
},
- "id": "ArrayValue",
- "description": "An array value.",
- "type": "object"
- },
- "Projection": {
- "description": "A representation of a property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
- }
- },
- "id": "Projection"
+ "id": "ArrayValue"
},
"Mutation": {
- "id": "Mutation",
"description": "A mutation to apply to an entity.",
"type": "object",
"properties": {
- "delete": {
- "$ref": "Key",
- "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only."
- },
"insert": {
- "$ref": "Entity",
- "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete."
+ "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete.",
+ "$ref": "Entity"
},
"baseVersion": {
"description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
@@ -898,14 +1000,19 @@
"type": "string"
},
"update": {
- "description": "The entity to update. The entity must already exist.\nMust have a complete key path.",
- "$ref": "Entity"
+ "$ref": "Entity",
+ "description": "The entity to update. The entity must already exist.\nMust have a complete key path."
},
"upsert": {
"$ref": "Entity",
"description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete."
+ },
+ "delete": {
+ "$ref": "Key",
+ "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only."
}
- }
+ },
+ "id": "Mutation"
},
"ReadOptions": {
"description": "The options shared by read requests.",
@@ -932,111 +1039,6 @@
}
},
"id": "ReadOptions"
- },
- "RollbackResponse": {
- "description": "The response for Datastore.Rollback.\n(an empty message).",
- "type": "object",
- "properties": {},
- "id": "RollbackResponse"
- },
- "MutationResult": {
- "description": "The result of applying a mutation.",
- "type": "object",
- "properties": {
- "version": {
- "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
- "format": "int64",
- "type": "string"
- },
- "conflictDetected": {
- "description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
- "type": "boolean"
- },
- "key": {
- "$ref": "Key",
- "description": "The automatically allocated key.\nSet only when the mutation allocated a key."
- }
- },
- "id": "MutationResult"
- },
- "GqlQuery": {
- "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
- "type": "object",
- "properties": {
- "queryString": {
- "type": "string",
- "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference)."
- },
- "allowLiterals": {
- "description": "When false, the query string must not contain any literals and instead must\nbind all values. For example,\n`SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE a = @value` is.",
- "type": "boolean"
- },
- "namedBindings": {
- "additionalProperties": {
- "$ref": "GqlQueryParameter"
- },
- "description": "For each non-reserved named binding site in the query string, there must be\na named parameter with that name, but not necessarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`__.*__`, and must not be `\"\"`.",
- "type": "object"
- },
- "positionalBindings": {
- "description": "Numbered binding site @1 references the first numbered parameter,\neffectively using 1-based indexing, rather than the usual 0.\n\nFor each binding site numbered i in `query_string`, there must be an i-th\nnumbered parameter. The inverse must also be true.",
- "type": "array",
- "items": {
- "$ref": "GqlQueryParameter"
- }
- }
- },
- "id": "GqlQuery"
- },
- "Filter": {
- "properties": {
- "propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
- },
- "compositeFilter": {
- "$ref": "CompositeFilter",
- "description": "A composite filter."
- }
- },
- "id": "Filter",
- "description": "A holder for any type of filter.",
- "type": "object"
- },
- "RunQueryRequest": {
- "description": "The request for Datastore.RunQuery.",
- "type": "object",
- "properties": {
- "partitionId": {
- "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID.",
- "$ref": "PartitionId"
- },
- "gqlQuery": {
- "$ref": "GqlQuery",
- "description": "The GQL query to run."
- },
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this query."
- },
- "query": {
- "$ref": "Query",
- "description": "The query to run."
- }
- },
- "id": "RunQueryRequest"
- },
- "RollbackRequest": {
- "type": "object",
- "properties": {
- "transaction": {
- "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "RollbackRequest",
- "description": "The request for Datastore.Rollback."
}
},
"icons": {
@@ -1049,27 +1051,25 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/datastore": {
- "description": "View and manage your Google Cloud Datastore data"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/datastore": {
+ "description": "View and manage your Google Cloud Datastore data"
}
}
}
},
- "servicePath": "",
- "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
"kind": "discovery#restDescription",
+ "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
+ "servicePath": "",
"rootUrl": "https://datastore.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "datastore",
"batchPath": "batch",
- "id": "datastore:v1beta3",
"documentationLink": "https://cloud.google.com/datastore/",
- "revision": "20170502",
- "title": "Google Cloud Datastore API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "revision": "20170523",
+ "id": "datastore:v1beta3",
+ "title": "Google Cloud Datastore API"
}
diff --git a/datastore/v1beta3/datastore-gen.go b/datastore/v1beta3/datastore-gen.go
index b73b29f..dfb8ff4 100644
--- a/datastore/v1beta3/datastore-gen.go
+++ b/datastore/v1beta3/datastore-gen.go
@@ -710,10 +710,6 @@
// 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].
diff --git a/dlp/v2beta1/dlp-api.json b/dlp/v2beta1/dlp-api.json
index 80fb05f..3523810 100644
--- a/dlp/v2beta1/dlp-api.json
+++ b/dlp/v2beta1/dlp-api.json
@@ -1,4 +1,1115 @@
{
+ "ownerName": "Google",
+ "resources": {
+ "inspect": {
+ "resources": {
+ "results": {
+ "resources": {
+ "findings": {
+ "methods": {
+ "list": {
+ "id": "dlp.inspect.results.findings.list",
+ "path": "v2beta1/{+name}/findings",
+ "description": "Returns list of results for given inspect operation result set id.",
+ "response": {
+ "$ref": "ListInspectFindingsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListInspectFindingsResponse`; indicates\nthat this is a continuation of a prior `ListInspectFindings` call, and that\nthe system should return the next page of data.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Identifier of the results set returned as metadata of\nthe longrunning operation created by a call to CreateInspectOperation.\nShould be in the format of `inspect/results/{id}.",
+ "type": "string",
+ "required": true,
+ "pattern": "^inspect/results/[^/]+$",
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of results to return.\nIf 0, the implementation select a reasonable value.",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "Restrict findings to items that match. Supports info_type and likelihood.\n\u003cp\u003eExamples:\u003cbr/\u003e\n\u003cli\u003einfo_type=EMAIL_ADDRESS\n\u003cli\u003einfo_type=PHONE_NUMBER,EMAIL_ADDRESS\n\u003cli\u003elikelihood=VERY_LIKELY\n\u003cli\u003elikelihood=VERY_LIKELY,LIKELY\n\u003cli\u003einfo_type=EMAIL_ADDRESS,likelihood=VERY_LIKELY,LIKELY",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/inspect/results/{resultsId}/findings"
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "create": {
+ "id": "dlp.inspect.operations.create",
+ "path": "v2beta1/inspect/operations",
+ "request": {
+ "$ref": "CreateInspectOperationRequest"
+ },
+ "description": "Schedule a job scanning content in a Google Cloud Platform data repository.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v2beta1/inspect/operations"
+ },
+ "cancel": {
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Cancels an operation. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^inspect/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel",
+ "path": "v2beta1/{+name}:cancel",
+ "id": "dlp.inspect.operations.cancel"
+ },
+ "delete": {
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true,
+ "pattern": "^inspect/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/inspect/operations/{operationsId}",
+ "id": "dlp.inspect.operations.delete",
+ "path": "v2beta1/{+name}"
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^inspect/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/operations/{operationsId}",
+ "id": "dlp.inspect.operations.get",
+ "path": "v2beta1/{+name}"
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "This parameter supports filtering by done, ie done=true or done=false.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^inspect/operations$",
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The list page size. The max allowed value is 256 and default is 100.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/operations",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.inspect.operations.list"
+ }
+ }
+ }
+ }
+ },
+ "rootCategories": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListRootCategoriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "languageCode": {
+ "description": "Optional language code for localized friendly category names.\nIf omitted or if localized strings are not available,\nen-US strings will be returned.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/rootCategories",
+ "id": "dlp.rootCategories.list",
+ "path": "v2beta1/rootCategories",
+ "description": "Returns the list of root categories of sensitive information."
+ }
+ },
+ "resources": {
+ "infoTypes": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListInfoTypesResponse"
+ },
+ "parameterOrder": [
+ "category"
+ ],
+ "parameters": {
+ "category": {
+ "pattern": "^[^/]+$",
+ "location": "path",
+ "description": "Category name as returned by ListRootCategories.",
+ "type": "string",
+ "required": true
+ },
+ "languageCode": {
+ "description": "Optional BCP-47 language code for localized info type friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/rootCategories/{rootCategoriesId}/infoTypes",
+ "path": "v2beta1/rootCategories/{+category}/infoTypes",
+ "id": "dlp.rootCategories.infoTypes.list",
+ "description": "Returns sensitive information types for given category."
+ }
+ }
+ }
+ }
+ },
+ "content": {
+ "methods": {
+ "inspect": {
+ "description": "Find potentially sensitive info in a list of strings.\nThis method has limits on input size, processing time, and output size.",
+ "request": {
+ "$ref": "InspectContentRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "InspectContentResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/content:inspect",
+ "path": "v2beta1/content:inspect",
+ "id": "dlp.content.inspect"
+ },
+ "redact": {
+ "description": "Redact potentially sensitive info from a list of strings.\nThis method has limits on input size, processing time, and output size.",
+ "request": {
+ "$ref": "RedactContentRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "RedactContentResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/content:redact",
+ "path": "v2beta1/content:redact",
+ "id": "dlp.content.redact"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ }
+ },
+ "version": "v2beta1",
+ "baseUrl": "https://dlp.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20170530",
+ "documentationLink": "https://cloud.google.com/dlp/docs/",
+ "id": "dlp:v2beta1",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "schemas": {
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "DatastoreKey": {
+ "description": "Record key for a finding in Cloud Datastore.",
+ "type": "object",
+ "properties": {
+ "entityKey": {
+ "$ref": "Key",
+ "description": "Datastore entity key."
+ }
+ },
+ "id": "DatastoreKey"
+ },
+ "ListRootCategoriesResponse": {
+ "description": "Response for ListRootCategories request.",
+ "type": "object",
+ "properties": {
+ "categories": {
+ "description": "List of all into type categories supported by the API.",
+ "items": {
+ "$ref": "CategoryDescription"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListRootCategoriesResponse"
+ },
+ "Location": {
+ "properties": {
+ "imageBoxes": {
+ "description": "Location within an image's pixels.",
+ "items": {
+ "$ref": "ImageLocation"
+ },
+ "type": "array"
+ },
+ "byteRange": {
+ "description": "Zero-based byte offsets within a content item.",
+ "$ref": "Range"
+ },
+ "recordKey": {
+ "description": "Key of the finding.",
+ "$ref": "RecordKey"
+ },
+ "codepointRange": {
+ "description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8.",
+ "$ref": "Range"
+ },
+ "fieldId": {
+ "description": "Field id of the field containing the finding.",
+ "$ref": "FieldId"
+ }
+ },
+ "id": "Location",
+ "description": "Specifies the location of a finding within its source item.",
+ "type": "object"
+ },
+ "ListInspectFindingsResponse": {
+ "description": "Response to the ListInspectFindings request.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more results that match the\nrequest; this value should be passed in a new `ListInspectFindingsRequest`.",
+ "type": "string"
+ },
+ "result": {
+ "description": "The results.",
+ "$ref": "InspectResult"
+ }
+ },
+ "id": "ListInspectFindingsResponse"
+ },
+ "RecordKey": {
+ "description": "Message for a unique key indicating a record that contains a finding.",
+ "type": "object",
+ "properties": {
+ "datastoreKey": {
+ "$ref": "DatastoreKey"
+ },
+ "cloudStorageKey": {
+ "$ref": "CloudStorageKey"
+ }
+ },
+ "id": "RecordKey"
+ },
+ "Finding": {
+ "description": "Container structure describing a single finding within a string or image.",
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Timestamp when finding was detected.",
+ "type": "string"
+ },
+ "infoType": {
+ "description": "The specific type of info the string might be.",
+ "$ref": "InfoType"
+ },
+ "location": {
+ "$ref": "Location",
+ "description": "Location of the info found."
+ },
+ "quote": {
+ "description": "The specific string that may be potentially sensitive info.",
+ "type": "string"
+ },
+ "likelihood": {
+ "enumDescriptions": [
+ "Default value; information with all likelihoods is included.",
+ "Few matching elements.",
+ "",
+ "Some matching elements.",
+ "",
+ "Many matching elements."
+ ],
+ "enum": [
+ "LIKELIHOOD_UNSPECIFIED",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Estimate of how likely it is that the info_type is correct.",
+ "type": "string"
+ }
+ },
+ "id": "Finding"
+ },
+ "ContentItem": {
+ "properties": {
+ "value": {
+ "description": "String data to inspect or redact.",
+ "type": "string"
+ },
+ "data": {
+ "format": "byte",
+ "description": "Content data to inspect or redact.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: all \"text\" types, octet streams, PNG images,\nJPEG images.",
+ "type": "string"
+ }
+ },
+ "id": "ContentItem",
+ "description": "Container structure for the content to inspect.",
+ "type": "object"
+ },
+ "InspectContentResponse": {
+ "properties": {
+ "results": {
+ "description": "Each content_item from the request has a result in this list, in the\nsame order as the request.",
+ "items": {
+ "$ref": "InspectResult"
+ },
+ "type": "array"
+ }
+ },
+ "id": "InspectContentResponse",
+ "description": "Results of inspecting a list of items.",
+ "type": "object"
+ },
+ "CreateInspectOperationRequest": {
+ "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
+ "type": "object",
+ "properties": {
+ "storageConfig": {
+ "$ref": "StorageConfig",
+ "description": "Specification of the data set to process."
+ },
+ "outputConfig": {
+ "description": "Optional location to store findings. The bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\n\u003cp\u003eResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written. \u003cp\u003eThe CSV file(s) contain the\nfollowing columns regardless of storage type scanned: \u003cli\u003eid \u003cli\u003einfo_type\n\u003cli\u003elikelihood \u003cli\u003ebyte size of finding \u003cli\u003equote \u003cli\u003etime_stamp\u003cbr/\u003e\n\u003cp\u003eFor Cloud Storage the next columns are: \u003cli\u003efile_path\n\u003cli\u003estart_offset\u003cbr/\u003e\n\u003cp\u003eFor Cloud Datastore the next columns are: \u003cli\u003eproject_id\n\u003cli\u003enamespace_id \u003cli\u003epath \u003cli\u003ecolumn_name \u003cli\u003eoffset",
+ "$ref": "OutputStorageConfig"
+ },
+ "inspectConfig": {
+ "$ref": "InspectConfig",
+ "description": "Configuration for the inspector."
+ }
+ },
+ "id": "CreateInspectOperationRequest"
+ },
+ "InspectConfig": {
+ "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
+ "type": "object",
+ "properties": {
+ "maxFindings": {
+ "format": "int32",
+ "description": "Limit the number of findings per content item.",
+ "type": "integer"
+ },
+ "excludeTypes": {
+ "description": "When true, exclude type information of the findings.",
+ "type": "boolean"
+ },
+ "infoTypes": {
+ "description": "Restrict what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
+ "items": {
+ "$ref": "InfoType"
+ },
+ "type": "array"
+ },
+ "includeQuote": {
+ "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
+ "type": "boolean"
+ },
+ "minLikelihood": {
+ "enumDescriptions": [
+ "Default value; information with all likelihoods is included.",
+ "Few matching elements.",
+ "",
+ "Some matching elements.",
+ "",
+ "Many matching elements."
+ ],
+ "enum": [
+ "LIKELIHOOD_UNSPECIFIED",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Only return findings equal or above this threshold.",
+ "type": "string"
+ }
+ },
+ "id": "InspectConfig"
+ },
+ "InfoType": {
+ "properties": {
+ "name": {
+ "description": "Name of the information type. For built-in info types, this is provided by\nthe API call ListInfoTypes. For user-defined info types, this is\nprovided by the user. All user-defined info types must have unique names,\nand cannot conflict with built-in info type names.",
+ "type": "string"
+ }
+ },
+ "id": "InfoType",
+ "description": "Type of information detected by the API.",
+ "type": "object"
+ },
+ "ReplaceConfig": {
+ "type": "object",
+ "properties": {
+ "replaceWith": {
+ "description": "Content replacing sensitive information of given type. Max 256 chars.",
+ "type": "string"
+ },
+ "infoType": {
+ "$ref": "InfoType",
+ "description": "Type of information to replace. Only one ReplaceConfig per info_type\nshould be provided. If ReplaceConfig does not have an info_type, the DLP\nAPI matches it against all info_types that are found but not specified in\nanother ReplaceConfig."
+ }
+ },
+ "id": "ReplaceConfig"
+ },
+ "FileSet": {
+ "properties": {
+ "url": {
+ "description": "The url, in the format `gs://\u003cbucket\u003e/\u003cpath\u003e`. Trailing wildcard in the\npath is allowed.",
+ "type": "string"
+ }
+ },
+ "id": "FileSet",
+ "description": "Set of files to scan.",
+ "type": "object"
+ },
+ "StorageConfig": {
+ "properties": {
+ "cloudStorageOptions": {
+ "description": "Google Cloud Storage options specification.",
+ "$ref": "CloudStorageOptions"
+ },
+ "datastoreOptions": {
+ "description": "Google Cloud Datastore options specification.",
+ "$ref": "DatastoreOptions"
+ }
+ },
+ "id": "StorageConfig",
+ "description": "Shared message indicating Cloud storage type.",
+ "type": "object"
+ },
+ "OutputStorageConfig": {
+ "properties": {
+ "storagePath": {
+ "$ref": "CloudStoragePath",
+ "description": "The path to a Google Cloud Storage location to store output."
+ }
+ },
+ "id": "OutputStorageConfig",
+ "description": "Cloud repository for storing output.",
+ "type": "object"
+ },
+ "RedactContentRequest": {
+ "properties": {
+ "replaceConfigs": {
+ "description": "The strings to replace findings with. Must specify at least one.",
+ "items": {
+ "$ref": "ReplaceConfig"
+ },
+ "type": "array"
+ },
+ "inspectConfig": {
+ "description": "Configuration for the inspector.",
+ "$ref": "InspectConfig"
+ },
+ "items": {
+ "description": "The list of items to inspect. Up to 100 are allowed per request.",
+ "items": {
+ "$ref": "ContentItem"
+ },
+ "type": "array"
+ }
+ },
+ "id": "RedactContentRequest",
+ "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.",
+ "type": "object"
+ },
+ "PartitionId": {
+ "properties": {
+ "namespaceId": {
+ "description": "If not empty, the ID of the namespace to which the entities belong.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the project to which the entities belong.",
+ "type": "string"
+ }
+ },
+ "id": "PartitionId",
+ "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
+ "type": "object"
+ },
+ "CategoryDescription": {
+ "properties": {
+ "name": {
+ "description": "Internal name of the category.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Human readable form of the category name.",
+ "type": "string"
+ }
+ },
+ "id": "CategoryDescription",
+ "description": "Info Type Category description.",
+ "type": "object"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
+ "Operation": {
+ "properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "This field will contain an `InspectOperationResult` object.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, The `name` should have the format of `inspect/operations/\u003cidentifier\u003e`.",
+ "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": "This field will contain an `InspectOperationMetadata` object.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
+ },
+ "CloudStorageOptions": {
+ "properties": {
+ "fileSet": {
+ "$ref": "FileSet"
+ }
+ },
+ "id": "CloudStorageOptions",
+ "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
+ "type": "object"
+ },
+ "PathElement": {
+ "properties": {
+ "name": {
+ "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
+ "id": {
+ "format": "int64",
+ "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
+ "type": "string"
+ }
+ },
+ "id": "PathElement",
+ "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
+ "type": "object"
+ },
+ "InspectResult": {
+ "description": "All the findings for a single scanned item.",
+ "type": "object",
+ "properties": {
+ "findingsTruncated": {
+ "description": "If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.",
+ "type": "boolean"
+ },
+ "findings": {
+ "description": "List of findings for an item.",
+ "items": {
+ "$ref": "Finding"
+ },
+ "type": "array"
+ }
+ },
+ "id": "InspectResult"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ }
+ },
+ "id": "Status"
+ },
+ "RedactContentResponse": {
+ "properties": {
+ "items": {
+ "description": "The redacted content.",
+ "items": {
+ "$ref": "ContentItem"
+ },
+ "type": "array"
+ }
+ },
+ "id": "RedactContentResponse",
+ "description": "Results of redacting a list of items.",
+ "type": "object"
+ },
+ "Range": {
+ "properties": {
+ "start": {
+ "format": "int64",
+ "description": "Index of the first character of the range (inclusive).",
+ "type": "string"
+ },
+ "end": {
+ "format": "int64",
+ "description": "Index of the last character of the range (exclusive).",
+ "type": "string"
+ }
+ },
+ "id": "Range",
+ "description": "Generic half-open interval [start, end)",
+ "type": "object"
+ },
+ "FieldId": {
+ "properties": {
+ "columnName": {
+ "description": "Column name describing the field.",
+ "type": "string"
+ }
+ },
+ "id": "FieldId",
+ "description": "General identifier of a data field in a storage service.",
+ "type": "object"
+ },
+ "ListInfoTypesResponse": {
+ "properties": {
+ "infoTypes": {
+ "description": "Set of sensitive info types belonging to a category.",
+ "items": {
+ "$ref": "InfoTypeDescription"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListInfoTypesResponse",
+ "description": "Response to the ListInfoTypes request.",
+ "type": "object"
+ },
+ "KindExpression": {
+ "properties": {
+ "name": {
+ "description": "The name of the kind.",
+ "type": "string"
+ }
+ },
+ "id": "KindExpression",
+ "description": "A representation of a Datastore kind.",
+ "type": "object"
+ },
+ "Key": {
+ "description": "A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nA path can never be empty, and a path can have at most 100 elements.",
+ "items": {
+ "$ref": "PathElement"
+ },
+ "type": "array"
+ },
+ "partitionId": {
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.",
+ "$ref": "PartitionId"
+ }
+ },
+ "id": "Key"
+ },
+ "InspectContentRequest": {
+ "properties": {
+ "inspectConfig": {
+ "description": "Configuration for the inspector.",
+ "$ref": "InspectConfig"
+ },
+ "items": {
+ "description": "The list of items to inspect. Items in a single request are\nconsidered \"related\" unless inspect_config.independent_inputs is true.\nUp to 100 are allowed per request.",
+ "items": {
+ "$ref": "ContentItem"
+ },
+ "type": "array"
+ }
+ },
+ "id": "InspectContentRequest",
+ "description": "Request to search for potentially sensitive info in a list of items.",
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
+ },
+ "PropertyReference": {
+ "properties": {
+ "name": {
+ "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
+ "type": "string"
+ }
+ },
+ "id": "PropertyReference",
+ "description": "A reference to a property relative to the Datastore kind expressions.",
+ "type": "object"
+ },
+ "Projection": {
+ "properties": {
+ "property": {
+ "description": "The property to project.",
+ "$ref": "PropertyReference"
+ }
+ },
+ "id": "Projection",
+ "description": "A representation of a Datastore property in a projection.",
+ "type": "object"
+ },
+ "CloudStoragePath": {
+ "properties": {
+ "path": {
+ "description": "The url, in the format of `gs://bucket/\u003cpath\u003e`.",
+ "type": "string"
+ }
+ },
+ "id": "CloudStoragePath",
+ "description": "A location in Cloud Storage.",
+ "type": "object"
+ },
+ "InfoTypeDescription": {
+ "properties": {
+ "name": {
+ "description": "Internal name of the info type.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Human readable form of the info type name.",
+ "type": "string"
+ },
+ "categories": {
+ "description": "List of categories this info type belongs to.",
+ "items": {
+ "$ref": "CategoryDescription"
+ },
+ "type": "array"
+ }
+ },
+ "id": "InfoTypeDescription",
+ "description": "Info type description.",
+ "type": "object"
+ },
+ "ImageLocation": {
+ "description": "Bounding box encompassing detected text within an image.",
+ "type": "object",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "description": "Height of the bounding box in pixels.",
+ "type": "integer"
+ },
+ "top": {
+ "format": "int32",
+ "description": "Top coordinate of the bounding box. (0,0) is upper left.",
+ "type": "integer"
+ },
+ "left": {
+ "format": "int32",
+ "description": "Left coordinate of the bounding box. (0,0) is upper left.",
+ "type": "integer"
+ },
+ "width": {
+ "format": "int32",
+ "description": "Width of the bounding box in pixels.",
+ "type": "integer"
+ }
+ },
+ "id": "ImageLocation"
+ },
+ "CloudStorageKey": {
+ "properties": {
+ "filePath": {
+ "description": "Path to the file.",
+ "type": "string"
+ },
+ "startOffset": {
+ "format": "int64",
+ "description": "Byte offset of the referenced data in the file.",
+ "type": "string"
+ }
+ },
+ "id": "CloudStorageKey",
+ "description": "Record key for a finding in a Cloud Storage file.",
+ "type": "object"
+ },
+ "DatastoreOptions": {
+ "properties": {
+ "partitionId": {
+ "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.",
+ "$ref": "PartitionId"
+ },
+ "projection": {
+ "description": "Properties to scan. If none are specified, all properties will be scanned\nby default.",
+ "items": {
+ "$ref": "Projection"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "$ref": "KindExpression",
+ "description": "The kind to process."
+ }
+ },
+ "id": "DatastoreOptions",
+ "description": "Options defining a data set within Google Cloud Datastore.",
+ "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": "DLP",
"auth": {
"oauth2": {
@@ -13,1111 +1124,5 @@
"ownerDomain": "google.com",
"name": "dlp",
"batchPath": "batch",
- "title": "DLP API",
- "ownerName": "Google",
- "resources": {
- "inspect": {
- "resources": {
- "results": {
- "resources": {
- "findings": {
- "methods": {
- "list": {
- "flatPath": "v2beta1/inspect/results/{resultsId}/findings",
- "id": "dlp.inspect.results.findings.list",
- "path": "v2beta1/{+name}/findings",
- "description": "Returns list of results for given inspect operation result set id.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListInspectFindingsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^inspect/results/[^/]+$",
- "location": "path",
- "description": "Identifier of the results set returned as metadata of\nthe longrunning operation created by a call to CreateInspectOperation.\nShould be in the format of `inspect/results/{id}."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The value returned by the last `ListInspectFindingsResponse`; indicates\nthat this is a continuation of a prior `ListInspectFindings` call, and that\nthe system should return the next page of data."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Maximum number of results to return.\nIf 0, the implementation select a reasonable value.",
- "format": "int32"
- }
- }
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^inspect/operations$",
- "location": "path",
- "description": "The name of the operation collection."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The list page token."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The list page size. The max allowed value is 256 and default is 100.",
- "format": "int32"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "This parameter supports filtering by done, ie done=true or done=false."
- }
- },
- "flatPath": "v2beta1/inspect/operations",
- "path": "v2beta1/{+name}",
- "id": "dlp.inspect.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": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^inspect/operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/inspect/operations/{operationsId}",
- "path": "v2beta1/{+name}",
- "id": "dlp.inspect.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "create": {
- "flatPath": "v2beta1/inspect/operations",
- "path": "v2beta1/inspect/operations",
- "id": "dlp.inspect.operations.create",
- "description": "Schedule a job scanning content in a Google Cloud Platform data repository.",
- "request": {
- "$ref": "CreateInspectOperationRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {}
- },
- "cancel": {
- "description": "Cancels an operation. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^inspect/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled."
- }
- },
- "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel",
- "path": "v2beta1/{+name}:cancel",
- "id": "dlp.inspect.operations.cancel"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^inspect/operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/inspect/operations/{operationsId}",
- "id": "dlp.inspect.operations.delete",
- "path": "v2beta1/{+name}",
- "description": "This method is not supported and the server returns `UNIMPLEMENTED`."
- }
- }
- }
- }
- },
- "content": {
- "methods": {
- "inspect": {
- "response": {
- "$ref": "InspectContentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/content:inspect",
- "path": "v2beta1/content:inspect",
- "id": "dlp.content.inspect",
- "request": {
- "$ref": "InspectContentRequest"
- },
- "description": "Find potentially sensitive info in a list of strings.\nThis method has limits on input size, processing time, and output size."
- },
- "redact": {
- "flatPath": "v2beta1/content:redact",
- "id": "dlp.content.redact",
- "path": "v2beta1/content:redact",
- "description": "Redact potentially sensitive info from a list of strings.\nThis method has limits on input size, processing time, and output size.",
- "request": {
- "$ref": "RedactContentRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "RedactContentResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {}
- }
- }
- },
- "rootCategories": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListRootCategoriesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "languageCode": {
- "location": "query",
- "description": "Optional language code for localized friendly category names.\nIf omitted or if localized strings are not available,\nen-US strings will be returned.",
- "type": "string"
- }
- },
- "flatPath": "v2beta1/rootCategories",
- "id": "dlp.rootCategories.list",
- "path": "v2beta1/rootCategories",
- "description": "Returns the list of root categories of sensitive information."
- }
- },
- "resources": {
- "infoTypes": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListInfoTypesResponse"
- },
- "parameterOrder": [
- "category"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "category": {
- "location": "path",
- "description": "Category name as returned by ListRootCategories.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$"
- },
- "languageCode": {
- "location": "query",
- "description": "Optional BCP-47 language code for localized info type friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.",
- "type": "string"
- }
- },
- "flatPath": "v2beta1/rootCategories/{rootCategoriesId}/infoTypes",
- "path": "v2beta1/rootCategories/{+category}/infoTypes",
- "id": "dlp.rootCategories.infoTypes.list",
- "description": "Returns sensitive information types for given category."
- }
- }
- }
- }
- }
- },
- "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": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "$.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": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- }
- },
- "version": "v2beta1",
- "baseUrl": "https://dlp.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
- "servicePath": "",
- "basePath": "",
- "revision": "20170502",
- "documentationLink": "https://cloud.google.com/dlp/docs/",
- "id": "dlp:v2beta1",
- "discoveryVersion": "v1",
- "version_module": "True",
- "schemas": {
- "PropertyReference": {
- "description": "A reference to a property relative to the Datastore kind expressions.",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path."
- }
- },
- "id": "PropertyReference"
- },
- "Projection": {
- "type": "object",
- "properties": {
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
- }
- },
- "id": "Projection",
- "description": "A representation of a Datastore property in a projection."
- },
- "CloudStoragePath": {
- "type": "object",
- "properties": {
- "path": {
- "description": "The url, in the format of `gs://bucket/\u003cpath\u003e`.",
- "type": "string"
- }
- },
- "id": "CloudStoragePath",
- "description": "A location in Cloud Storage."
- },
- "InfoTypeDescription": {
- "type": "object",
- "properties": {
- "categories": {
- "type": "array",
- "items": {
- "$ref": "CategoryDescription"
- },
- "description": "List of categories this info type belongs to."
- },
- "name": {
- "type": "string",
- "description": "Internal name of the info type."
- },
- "displayName": {
- "type": "string",
- "description": "Human readable form of the info type name."
- }
- },
- "id": "InfoTypeDescription",
- "description": "Info type description."
- },
- "ImageLocation": {
- "type": "object",
- "properties": {
- "left": {
- "description": "Left coordinate of the bounding box. (0,0) is upper left.",
- "format": "int32",
- "type": "integer"
- },
- "width": {
- "type": "integer",
- "description": "Width of the bounding box in pixels.",
- "format": "int32"
- },
- "height": {
- "description": "Height of the bounding box in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "top": {
- "description": "Top coordinate of the bounding box. (0,0) is upper left.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ImageLocation",
- "description": "Bounding box encompassing detected text within an image."
- },
- "CloudStorageKey": {
- "description": "Record key for a finding in a Cloud Storage file.",
- "type": "object",
- "properties": {
- "filePath": {
- "type": "string",
- "description": "Path to the file."
- },
- "startOffset": {
- "description": "Byte offset of the referenced data in the file.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "CloudStorageKey"
- },
- "DatastoreOptions": {
- "type": "object",
- "properties": {
- "partitionId": {
- "$ref": "PartitionId",
- "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty."
- },
- "kind": {
- "$ref": "KindExpression",
- "description": "The kind to process."
- },
- "projection": {
- "type": "array",
- "items": {
- "$ref": "Projection"
- },
- "description": "Properties to scan. If none are specified, all properties will be scanned\nby default."
- }
- },
- "id": "DatastoreOptions",
- "description": "Options defining a data set within Google Cloud Datastore."
- },
- "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"
- },
- "ListRootCategoriesResponse": {
- "description": "Response for ListRootCategories request.",
- "type": "object",
- "properties": {
- "categories": {
- "type": "array",
- "items": {
- "$ref": "CategoryDescription"
- },
- "description": "List of all into type categories supported by the API."
- }
- },
- "id": "ListRootCategoriesResponse"
- },
- "DatastoreKey": {
- "type": "object",
- "properties": {
- "entityKey": {
- "$ref": "Key",
- "description": "Datastore entity key."
- }
- },
- "id": "DatastoreKey",
- "description": "Record key for a finding in Cloud Datastore."
- },
- "Location": {
- "type": "object",
- "properties": {
- "recordKey": {
- "$ref": "RecordKey",
- "description": "Key of the finding."
- },
- "codepointRange": {
- "$ref": "Range",
- "description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8."
- },
- "fieldId": {
- "$ref": "FieldId",
- "description": "Field id of the field containing the finding."
- },
- "imageBoxes": {
- "description": "Location within an image's pixels.",
- "type": "array",
- "items": {
- "$ref": "ImageLocation"
- }
- },
- "byteRange": {
- "$ref": "Range",
- "description": "Zero-based byte offsets within a content item."
- }
- },
- "id": "Location",
- "description": "Specifies the location of a finding within its source item."
- },
- "ListInspectFindingsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "If not empty, indicates that there may be more results that match the\nrequest; this value should be passed in a new `ListInspectFindingsRequest`."
- },
- "result": {
- "$ref": "InspectResult",
- "description": "The results."
- }
- },
- "id": "ListInspectFindingsResponse",
- "description": "Response to the ListInspectFindings request."
- },
- "RecordKey": {
- "type": "object",
- "properties": {
- "datastoreKey": {
- "$ref": "DatastoreKey"
- },
- "cloudStorageKey": {
- "$ref": "CloudStorageKey"
- }
- },
- "id": "RecordKey",
- "description": "Message for a unique key indicating a record that contains a finding."
- },
- "CreateInspectOperationRequest": {
- "type": "object",
- "properties": {
- "inspectConfig": {
- "$ref": "InspectConfig",
- "description": "Configuration for the inspector."
- },
- "storageConfig": {
- "$ref": "StorageConfig",
- "description": "Specification of the data set to process."
- },
- "outputConfig": {
- "$ref": "OutputStorageConfig",
- "description": "Optional location to store findings. The bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\n\u003cp\u003eResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written. \u003cp\u003eThe CSV file(s) contain the\nfollowing columns regardless of storage type scanned: \u003cli\u003eid \u003cli\u003einfo_type\n\u003cli\u003elikelihood \u003cli\u003ebyte size of finding \u003cli\u003equote \u003cli\u003etime_stamp\u003cbr/\u003e\n\u003cp\u003eFor Cloud Storage the next columns are: \u003cli\u003efile_path\n\u003cli\u003estart_offset\u003cbr/\u003e\n\u003cp\u003eFor Cloud Datastore the next columns are: \u003cli\u003eproject_id\n\u003cli\u003enamespace_id \u003cli\u003epath \u003cli\u003ecolumn_name \u003cli\u003eoffset"
- }
- },
- "id": "CreateInspectOperationRequest",
- "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository."
- },
- "InspectContentResponse": {
- "description": "Results of inspecting a list of items.",
- "type": "object",
- "properties": {
- "results": {
- "type": "array",
- "items": {
- "$ref": "InspectResult"
- },
- "description": "Each content_item from the request has a result in this list, in the\nsame order as the request."
- }
- },
- "id": "InspectContentResponse"
- },
- "ContentItem": {
- "description": "Container structure for the content to inspect.",
- "type": "object",
- "properties": {
- "data": {
- "description": "Content data to inspect or redact.",
- "format": "byte",
- "type": "string"
- },
- "type": {
- "type": "string",
- "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: all \"text\" types, octet streams, PNG images,\nJPEG images."
- },
- "value": {
- "type": "string",
- "description": "String data to inspect or redact."
- }
- },
- "id": "ContentItem"
- },
- "Finding": {
- "description": "Container structure describing a single finding within a string or image.",
- "type": "object",
- "properties": {
- "quote": {
- "description": "The specific string that may be potentially sensitive info.",
- "type": "string"
- },
- "location": {
- "$ref": "Location",
- "description": "Location of the info found."
- },
- "likelihood": {
- "type": "string",
- "enumDescriptions": [
- "Default value; information with all likelihoods is included.",
- "Few matching elements.",
- "",
- "Some matching elements.",
- "",
- "Many matching elements."
- ],
- "enum": [
- "LIKELIHOOD_UNSPECIFIED",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Estimate of how likely it is that the info_type is correct."
- },
- "infoType": {
- "$ref": "InfoType",
- "description": "The specific type of info the string might be."
- },
- "createTime": {
- "type": "string",
- "description": "Timestamp when finding was detected.",
- "format": "google-datetime"
- }
- },
- "id": "Finding"
- },
- "FileSet": {
- "description": "Set of files to scan.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The url, in the format `gs://\u003cbucket\u003e/\u003cpath\u003e`. Trailing wildcard in the\npath is allowed.",
- "type": "string"
- }
- },
- "id": "FileSet"
- },
- "ReplaceConfig": {
- "type": "object",
- "properties": {
- "infoType": {
- "$ref": "InfoType",
- "description": "Type of information to replace. Only one ReplaceConfig per info_type\nshould be provided. If ReplaceConfig does not have an info_type, the DLP\nAPI matches it against all info_types that are found but not specified in\nanother ReplaceConfig."
- },
- "replaceWith": {
- "type": "string",
- "description": "Content replacing sensitive information of given type. Max 256 chars."
- }
- },
- "id": "ReplaceConfig"
- },
- "InfoType": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the information type, provided by the API call ListInfoTypes.",
- "type": "string"
- }
- },
- "id": "InfoType",
- "description": "Type of information detected by the API."
- },
- "InspectConfig": {
- "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
- "type": "object",
- "properties": {
- "maxFindings": {
- "description": "Limit the number of findings per content item.",
- "format": "int32",
- "type": "integer"
- },
- "infoTypes": {
- "description": "Restrict what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
- "type": "array",
- "items": {
- "$ref": "InfoType"
- }
- },
- "excludeTypes": {
- "description": "When true, exclude type information of the findings.",
- "type": "boolean"
- },
- "includeQuote": {
- "type": "boolean",
- "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote."
- },
- "minLikelihood": {
- "type": "string",
- "enumDescriptions": [
- "Default value; information with all likelihoods is included.",
- "Few matching elements.",
- "",
- "Some matching elements.",
- "",
- "Many matching elements."
- ],
- "enum": [
- "LIKELIHOOD_UNSPECIFIED",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Only return findings equal or above this threshold."
- }
- },
- "id": "InspectConfig"
- },
- "StorageConfig": {
- "type": "object",
- "properties": {
- "datastoreOptions": {
- "$ref": "DatastoreOptions",
- "description": "Google Cloud Datastore options specification."
- },
- "cloudStorageOptions": {
- "$ref": "CloudStorageOptions",
- "description": "Google Cloud Storage options specification."
- }
- },
- "id": "StorageConfig",
- "description": "Shared message indicating Cloud storage type."
- },
- "OutputStorageConfig": {
- "description": "Cloud repository for storing output.",
- "type": "object",
- "properties": {
- "storagePath": {
- "$ref": "CloudStoragePath",
- "description": "The path to a Google Cloud Storage location to store output."
- }
- },
- "id": "OutputStorageConfig"
- },
- "RedactContentRequest": {
- "type": "object",
- "properties": {
- "inspectConfig": {
- "$ref": "InspectConfig",
- "description": "Configuration for the inspector."
- },
- "items": {
- "description": "The list of items to inspect. Up to 100 are allowed per request.",
- "type": "array",
- "items": {
- "$ref": "ContentItem"
- }
- },
- "replaceConfigs": {
- "description": "The strings to replace findings with. Must specify at least one.",
- "type": "array",
- "items": {
- "$ref": "ReplaceConfig"
- }
- }
- },
- "id": "RedactContentRequest",
- "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content."
- },
- "PartitionId": {
- "type": "object",
- "properties": {
- "projectId": {
- "type": "string",
- "description": "The ID of the project to which the entities belong."
- },
- "namespaceId": {
- "type": "string",
- "description": "If not empty, the ID of the namespace to which the entities belong."
- }
- },
- "id": "PartitionId",
- "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID."
- },
- "CategoryDescription": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Internal name of the category."
- },
- "displayName": {
- "type": "string",
- "description": "Human readable form of the category name."
- }
- },
- "id": "CategoryDescription",
- "description": "Info Type Category description."
- },
- "CancelOperationRequest": {
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation."
- },
- "Operation": {
- "type": "object",
- "properties": {
- "response": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "This field will contain an `InspectOperationResult` object."
- },
- "name": {
- "type": "string",
- "description": "The server-assigned name, The `name` should have the format of `inspect/operations/\u003cidentifier\u003e`."
- },
- "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": "This field will contain an `InspectOperationMetdata` object.",
- "type": "object"
- },
- "done": {
- "type": "boolean",
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable."
- }
- },
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
- },
- "CloudStorageOptions": {
- "type": "object",
- "properties": {
- "fileSet": {
- "$ref": "FileSet"
- }
- },
- "id": "CloudStorageOptions",
- "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket."
- },
- "PathElement": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`."
- },
- "kind": {
- "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- },
- "id": {
- "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "PathElement",
- "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete."
- },
- "InspectResult": {
- "type": "object",
- "properties": {
- "findingsTruncated": {
- "type": "boolean",
- "description": "If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches."
- },
- "findings": {
- "description": "List of findings for an item.",
- "type": "array",
- "items": {
- "$ref": "Finding"
- }
- }
- },
- "id": "InspectResult",
- "description": "All the findings for a single scanned item."
- },
- "Status": {
- "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": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "type": "object"
- }
- },
- "code": {
- "type": "integer",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- }
- },
- "id": "Status",
- "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."
- },
- "RedactContentResponse": {
- "type": "object",
- "properties": {
- "items": {
- "description": "The redacted content.",
- "type": "array",
- "items": {
- "$ref": "ContentItem"
- }
- }
- },
- "id": "RedactContentResponse",
- "description": "Results of deidentifying a list of items."
- },
- "Range": {
- "description": "Generic half-open interval [start, end)",
- "type": "object",
- "properties": {
- "start": {
- "description": "Index of the first character of the range (inclusive).",
- "format": "int64",
- "type": "string"
- },
- "end": {
- "description": "Index of the last character of the range (exclusive).",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "Range"
- },
- "FieldId": {
- "type": "object",
- "properties": {
- "columnName": {
- "description": "Column name describing the field.",
- "type": "string"
- }
- },
- "id": "FieldId",
- "description": "General identifier of a data field in a storage service."
- },
- "ListInfoTypesResponse": {
- "type": "object",
- "properties": {
- "infoTypes": {
- "description": "Set of sensitive info types belonging to a category.",
- "type": "array",
- "items": {
- "$ref": "InfoTypeDescription"
- }
- }
- },
- "id": "ListInfoTypesResponse",
- "description": "Response to the ListInfoTypes request."
- },
- "KindExpression": {
- "description": "A representation of a Datastore kind.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the kind.",
- "type": "string"
- }
- },
- "id": "KindExpression"
- },
- "InspectContentRequest": {
- "type": "object",
- "properties": {
- "inspectConfig": {
- "$ref": "InspectConfig",
- "description": "Configuration for the inspector."
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "ContentItem"
- },
- "description": "The list of items to inspect. Items in a single request are\nconsidered \"related\" unless inspect_config.independent_inputs is true.\nUp to 100 are allowed per request."
- }
- },
- "id": "InspectContentRequest",
- "description": "Request to search for potentially sensitive info in a list of items."
- },
- "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": {
- "type": "string",
- "description": "The standard List next-page token."
- }
- },
- "id": "ListOperationsResponse"
- },
- "Key": {
- "type": "object",
- "properties": {
- "partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
- },
- "path": {
- "type": "array",
- "items": {
- "$ref": "PathElement"
- },
- "description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nA path can never be empty, and a path can have at most 100 elements."
- }
- },
- "id": "Key",
- "description": "A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts."
- }
- },
- "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"
- }
+ "title": "DLP API"
}
diff --git a/dlp/v2beta1/dlp-gen.go b/dlp/v2beta1/dlp-gen.go
index 294093c..6faefbd 100644
--- a/dlp/v2beta1/dlp-gen.go
+++ b/dlp/v2beta1/dlp-gen.go
@@ -612,8 +612,13 @@
// InfoType: Type of information detected by the API.
type InfoType struct {
- // Name: Name of the information type, provided by the API call
- // ListInfoTypes.
+ // Name: Name of the information type. For built-in info types, this is
+ // provided by
+ // the API call ListInfoTypes. For user-defined info types, this
+ // is
+ // provided by the user. All user-defined info types must have unique
+ // names,
+ // and cannot conflict with built-in info type names.
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to
@@ -1118,7 +1123,7 @@
// cancellation.
Error *Status `json:"error,omitempty"`
- // Metadata: This field will contain an `InspectOperationMetdata`
+ // Metadata: This field will contain an `InspectOperationMetadata`
// object.
Metadata googleapi.RawMessage `json:"metadata,omitempty"`
@@ -1428,7 +1433,7 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// RedactContentResponse: Results of deidentifying a list of items.
+// RedactContentResponse: Results of redacting a list of items.
type RedactContentResponse struct {
// Items: The redacted content.
Items []*ContentItem `json:"items,omitempty"`
@@ -1525,7 +1530,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -1558,7 +1563,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
@@ -2436,9 +2441,18 @@
// server doesn't support this method, it returns
// `UNIMPLEMENTED`.
//
-// NOTE: the `name` binding below allows API services to override the
+// NOTE: the `name` binding allows API services to override the
// binding
// to use different resource name schemes, such as `users/*/operations`.
+// To
+// override the binding, API services can add a binding such
+// as
+// "/v1/{name=users/*}/operations" to their service configuration.
+// For backwards compatibility, the default name includes the
+// operations
+// collection id, however overriding users must ensure the name
+// binding
+// is the parent resource, without the operations collection id.
func (r *InspectOperationsService) List(name string) *InspectOperationsListCall {
c := &InspectOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -2560,7 +2574,7 @@
}
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`.",
+ // "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
// "flatPath": "v2beta1/inspect/operations",
// "httpMethod": "GET",
// "id": "dlp.inspect.operations.list",
@@ -2574,7 +2588,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "path",
// "pattern": "^inspect/operations$",
// "required": true,
@@ -2643,6 +2657,23 @@
return c
}
+// Filter sets the optional parameter "filter": Restrict findings to
+// items that match. Supports info_type and
+// likelihood.
+// <p>Examples:<br/>
+// <li>info_type=EMAIL_ADDRESS
+// <li>info_typ
+// e=PHONE_NUMBER,EMAIL_ADDRESS
+// <li>likelihood=VERY_LIKELY
+// <li>likelihood
+// =VERY_LIKELY,LIKELY
+// <li>info_type=EMAIL_ADDRESS,likelihood=VERY_LIKELY
+// ,LIKELY
+func (c *InspectResultsFindingsListCall) Filter(filter string) *InspectResultsFindingsListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
// PageSize sets the optional parameter "pageSize": Maximum number of
// results to return.
// If 0, the implementation select a reasonable value.
@@ -2763,6 +2794,11 @@
// "name"
// ],
// "parameters": {
+ // "filter": {
+ // "description": "Restrict findings to items that match. Supports info_type and likelihood.\n\u003cp\u003eExamples:\u003cbr/\u003e\n\u003cli\u003einfo_type=EMAIL_ADDRESS\n\u003cli\u003einfo_type=PHONE_NUMBER,EMAIL_ADDRESS\n\u003cli\u003elikelihood=VERY_LIKELY\n\u003cli\u003elikelihood=VERY_LIKELY,LIKELY\n\u003cli\u003einfo_type=EMAIL_ADDRESS,likelihood=VERY_LIKELY,LIKELY",
+ // "location": "query",
+ // "type": "string"
+ // },
// "name": {
// "description": "Identifier of the results set returned as metadata of\nthe longrunning operation created by a call to CreateInspectOperation.\nShould be in the format of `inspect/results/{id}.",
// "location": "path",
diff --git a/doubleclickbidmanager/v1/doubleclickbidmanager-api.json b/doubleclickbidmanager/v1/doubleclickbidmanager-api.json
index 13b078a..9ca6818 100644
--- a/doubleclickbidmanager/v1/doubleclickbidmanager-api.json
+++ b/doubleclickbidmanager/v1/doubleclickbidmanager-api.json
@@ -1,12 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/TpAruLLB982pPy6sW_n60NUC_v0\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/CyBb_evhvzpTXXhgZSc7wED-pLk\"",
"discoveryVersion": "v1",
"id": "doubleclickbidmanager:v1",
"name": "doubleclickbidmanager",
"canonicalName": "DoubleClick Bid Manager",
"version": "v1",
- "revision": "20170224",
+ "revision": "20170531",
"title": "DoubleClick Bid Manager API",
"description": "API for viewing and managing your reports in DoubleClick Bid Manager.",
"ownerDomain": "google.com",
@@ -89,11 +89,9 @@
"type": "string",
"description": "File specification (column names, types, order) in which the line items will be returned. Default to EWF.",
"enum": [
- "EWF",
- "SDF"
+ "EWF"
],
"enumDescriptions": [
- "",
""
]
},
@@ -235,6 +233,7 @@
"FILTER_AGE",
"FILTER_BRANDSAFE_CHANNEL_ID",
"FILTER_BROWSER",
+ "FILTER_BUDGET_SEGMENT_DESCRIPTION",
"FILTER_CAMPAIGN_DAILY_FREQUENCY",
"FILTER_CARRIER",
"FILTER_CHANNEL_ID",
@@ -461,6 +460,7 @@
"",
"",
"",
+ "",
""
]
},
@@ -535,6 +535,7 @@
"FILTER_AGE",
"FILTER_BRANDSAFE_CHANNEL_ID",
"FILTER_BROWSER",
+ "FILTER_BUDGET_SEGMENT_DESCRIPTION",
"FILTER_CAMPAIGN_DAILY_FREQUENCY",
"FILTER_CARRIER",
"FILTER_CHANNEL_ID",
@@ -761,6 +762,7 @@
"",
"",
"",
+ "",
""
]
}
@@ -967,6 +969,7 @@
"METRIC_PROFIT_VIEWABLE_ECPM_ADVERTISER",
"METRIC_PROFIT_VIEWABLE_ECPM_PARTNER",
"METRIC_PROFIT_VIEWABLE_ECPM_USD",
+ "METRIC_REACH_COOKIE_FREQUENCY",
"METRIC_REACH_COOKIE_REACH",
"METRIC_REVENUE_ADVERTISER",
"METRIC_REVENUE_ECPAPC_ADVERTISER",
@@ -1382,6 +1385,7 @@
"",
"",
"",
+ "",
""
]
}
diff --git a/doubleclickbidmanager/v1/doubleclickbidmanager-gen.go b/doubleclickbidmanager/v1/doubleclickbidmanager-gen.go
index 5f384a4..99139b0 100644
--- a/doubleclickbidmanager/v1/doubleclickbidmanager-gen.go
+++ b/doubleclickbidmanager/v1/doubleclickbidmanager-gen.go
@@ -127,7 +127,6 @@
//
// Possible values:
// "EWF"
- // "SDF"
FileSpec string `json:"fileSpec,omitempty"`
// FilterIds: Ids of the specified filter type used to filter line items
@@ -315,6 +314,7 @@
// "FILTER_AGE"
// "FILTER_BRANDSAFE_CHANNEL_ID"
// "FILTER_BROWSER"
+ // "FILTER_BUDGET_SEGMENT_DESCRIPTION"
// "FILTER_CAMPAIGN_DAILY_FREQUENCY"
// "FILTER_CARRIER"
// "FILTER_CHANNEL_ID"
@@ -540,6 +540,7 @@
// "FILTER_AGE"
// "FILTER_BRANDSAFE_CHANNEL_ID"
// "FILTER_BROWSER"
+ // "FILTER_BUDGET_SEGMENT_DESCRIPTION"
// "FILTER_CAMPAIGN_DAILY_FREQUENCY"
// "FILTER_CARRIER"
// "FILTER_CHANNEL_ID"
@@ -848,6 +849,7 @@
// "METRIC_PROFIT_VIEWABLE_ECPM_ADVERTISER"
// "METRIC_PROFIT_VIEWABLE_ECPM_PARTNER"
// "METRIC_PROFIT_VIEWABLE_ECPM_USD"
+ // "METRIC_REACH_COOKIE_FREQUENCY"
// "METRIC_REACH_COOKIE_REACH"
// "METRIC_REVENUE_ADVERTISER"
// "METRIC_REVENUE_ECPAPC_ADVERTISER"
diff --git a/drive/v2/drive-api.json b/drive/v2/drive-api.json
index 0ded1fb..88210e7 100644
--- a/drive/v2/drive-api.json
+++ b/drive/v2/drive-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/wZaClgEOt_sdgi-MJA2ZIUoCxK0\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/PQEMJru4Qkf5WTXrHGA16hWEFcw\"",
"discoveryVersion": "v1",
"id": "drive:v2",
"name": "drive",
"version": "v2",
- "revision": "20170420",
+ "revision": "20170519",
"title": "Drive API",
"description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.",
"ownerDomain": "google.com",
@@ -1080,7 +1080,7 @@
},
"hasThumbnail": {
"type": "boolean",
- "description": "Whether this file has a thumbnail."
+ "description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field."
},
"headRevisionId": {
"type": "string",
@@ -1604,7 +1604,7 @@
},
"deleted": {
"type": "boolean",
- "description": "Whether the account of the permission has been deleted. This field only pertains to user and group permissions."
+ "description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions."
},
"domain": {
"type": "string",
@@ -1949,7 +1949,7 @@
"properties": {
"backgroundImageFile": {
"type": "object",
- "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field that can only be set on a drive.teamdrives.update request that does not set themeId. When specified, all fields of the backgroundImageFile must be set.",
+ "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.",
"properties": {
"id": {
"type": "string",
@@ -1957,17 +1957,17 @@
},
"width": {
"type": "number",
- "description": "The width of the cropped image in the closed range of 0 to 1, which is the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.",
+ "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.",
"format": "float"
},
"xCoordinate": {
"type": "number",
- "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1 which is the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.",
+ "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.",
"format": "float"
},
"yCoordinate": {
"type": "number",
- "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1 which is the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.",
+ "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.",
"format": "float"
}
}
@@ -2057,7 +2057,7 @@
},
"themeId": {
"type": "string",
- "description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.insert request, a random theme is chosen from which the background image and color are set. This is a write only field that can only be set on a request that does not set colorRgb or backgroundImageFile."
+ "description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile."
}
}
},
diff --git a/drive/v2/drive-gen.go b/drive/v2/drive-gen.go
index 9e8c8a9..27567b2 100644
--- a/drive/v2/drive-gen.go
+++ b/drive/v2/drive-gen.go
@@ -1493,7 +1493,9 @@
// files.
HasAugmentedPermissions bool `json:"hasAugmentedPermissions,omitempty"`
- // HasThumbnail: Whether this file has a thumbnail.
+ // HasThumbnail: Whether this file has a thumbnail. This does not
+ // indicate whether the requesting app has access to the thumbnail. To
+ // check access, look for the presence of the thumbnailLink field.
HasThumbnail bool `json:"hasThumbnail,omitempty"`
// HeadRevisionId: The ID of the file's head revision. This field is
@@ -2307,8 +2309,8 @@
// AuthKey: The authkey parameter required for this permission.
AuthKey string `json:"authKey,omitempty"`
- // Deleted: Whether the account of the permission has been deleted. This
- // field only pertains to user and group permissions.
+ // Deleted: Whether the account associated with this permission has been
+ // deleted. This field only pertains to user and group permissions.
Deleted bool `json:"deleted,omitempty"`
// Domain: The domain name of the entity this permission refers to. This
@@ -2828,8 +2830,8 @@
type TeamDrive struct {
// BackgroundImageFile: An image file and cropping parameters from which
// a background image for this Team Drive is set. This is a write only
- // field that can only be set on a drive.teamdrives.update request that
- // does not set themeId. When specified, all fields of the
+ // field; it can only be set on drive.teamdrives.update requests that
+ // don't set themeId. When specified, all fields of the
// backgroundImageFile must be set.
BackgroundImageFile *TeamDriveBackgroundImageFile `json:"backgroundImageFile,omitempty"`
@@ -2859,8 +2861,8 @@
// color will be set. The set of possible teamDriveThemes can be
// retrieved from a drive.about.get response. When not specified on a
// drive.teamdrives.insert request, a random theme is chosen from which
- // the background image and color are set. This is a write only field
- // that can only be set on a request that does not set colorRgb or
+ // the background image and color are set. This is a write-only field;
+ // it can only be set on requests that don't set colorRgb or
// backgroundImageFile.
ThemeId string `json:"themeId,omitempty"`
@@ -2894,32 +2896,32 @@
// TeamDriveBackgroundImageFile: An image file and cropping parameters
// from which a background image for this Team Drive is set. This is a
-// write only field that can only be set on a drive.teamdrives.update
-// request that does not set themeId. When specified, all fields of the
+// write only field; it can only be set on drive.teamdrives.update
+// requests that don't set themeId. When specified, all fields of the
// backgroundImageFile must be set.
type TeamDriveBackgroundImageFile struct {
// Id: The ID of an image file in Drive to use for the background image.
Id string `json:"id,omitempty"`
- // Width: The width of the cropped image in the closed range of 0 to 1,
- // which is the width of the cropped image divided by the width of the
- // entire image. The height is computed by applying a width to height
- // aspect ratio of 80 to 9. The resulting image must be at least 1280
- // pixels wide and 144 pixels high.
+ // Width: The width of the cropped image in the closed range of 0 to 1.
+ // This value represents the width of the cropped image divided by the
+ // width of the entire image. The height is computed by applying a width
+ // to height aspect ratio of 80 to 9. The resulting image must be at
+ // least 1280 pixels wide and 144 pixels high.
Width float64 `json:"width,omitempty"`
// XCoordinate: The X coordinate of the upper left corner of the
// cropping area in the background image. This is a value in the closed
- // range of 0 to 1 which is the horizontal distance from the left side
- // of the entire image to the left side of the cropping area divided by
- // the width of the entire image.
+ // range of 0 to 1. This value represents the horizontal distance from
+ // the left side of the entire image to the left side of the cropping
+ // area divided by the width of the entire image.
XCoordinate float64 `json:"xCoordinate,omitempty"`
// YCoordinate: The Y coordinate of the upper left corner of the
// cropping area in the background image. This is a value in the closed
- // range of 0 to 1 which is the vertical distance from the top side of
- // the entire image to the top side of the cropping area divided by the
- // height of the entire image.
+ // range of 0 to 1. This value represents the vertical distance from the
+ // top side of the entire image to the top side of the cropping area
+ // divided by the height of the entire image.
YCoordinate float64 `json:"yCoordinate,omitempty"`
// ForceSendFields is a list of field names (e.g. "Id") to
diff --git a/drive/v3/drive-api.json b/drive/v3/drive-api.json
index 7b232b2..f58f0a1 100644
--- a/drive/v3/drive-api.json
+++ b/drive/v3/drive-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/WfoJVrpU3dcFjezsbCAPqfEXt3Y\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/wH03RLGjiQZHXW-bECcrydLGp0c\"",
"discoveryVersion": "v1",
"id": "drive:v3",
"name": "drive",
"version": "v3",
- "revision": "20170420",
+ "revision": "20170519",
"title": "Drive API",
"description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.",
"ownerDomain": "google.com",
@@ -567,7 +567,7 @@
},
"hasThumbnail": {
"type": "boolean",
- "description": "Whether this file has a thumbnail."
+ "description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field."
},
"headRevisionId": {
"type": "string",
@@ -947,7 +947,7 @@
},
"deleted": {
"type": "boolean",
- "description": "Whether the account of the permission has been deleted. This field only pertains to user and group permissions."
+ "description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions."
},
"displayName": {
"type": "string",
@@ -1008,7 +1008,7 @@
},
"teamDrivePermissionType": {
"type": "string",
- "description": "The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: \n- file\n- \n- member"
+ "description": "The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: \n- file \n- member"
}
}
}
@@ -1224,7 +1224,7 @@
"properties": {
"backgroundImageFile": {
"type": "object",
- "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field that can only be set on a drive.teamdrives.update request that does not set themeId. When specified, all fields of the backgroundImageFile must be set.",
+ "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.",
"properties": {
"id": {
"type": "string",
@@ -1232,17 +1232,17 @@
},
"width": {
"type": "number",
- "description": "The width of the cropped image in the closed range of 0 to 1, which is the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.",
+ "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.",
"format": "float"
},
"xCoordinate": {
"type": "number",
- "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1 which is the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.",
+ "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.",
"format": "float"
},
"yCoordinate": {
"type": "number",
- "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1 which is the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.",
+ "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.",
"format": "float"
}
}
@@ -1332,7 +1332,7 @@
},
"themeId": {
"type": "string",
- "description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write only field that can only be set on a request that does not set colorRgb or backgroundImageFile."
+ "description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile."
}
}
},
diff --git a/drive/v3/drive-gen.go b/drive/v3/drive-gen.go
index 722efde..685a439 100644
--- a/drive/v3/drive-gen.go
+++ b/drive/v3/drive-gen.go
@@ -714,7 +714,9 @@
// files.
HasAugmentedPermissions bool `json:"hasAugmentedPermissions,omitempty"`
- // HasThumbnail: Whether this file has a thumbnail.
+ // HasThumbnail: Whether this file has a thumbnail. This does not
+ // indicate whether the requesting app has access to the thumbnail. To
+ // check access, look for the presence of the thumbnailLink field.
HasThumbnail bool `json:"hasThumbnail,omitempty"`
// HeadRevisionId: The ID of the file's head revision. This is currently
@@ -1385,8 +1387,8 @@
// type domain or anyone.
AllowFileDiscovery bool `json:"allowFileDiscovery,omitempty"`
- // Deleted: Whether the account of the permission has been deleted. This
- // field only pertains to user and group permissions.
+ // Deleted: Whether the account associated with this permission has been
+ // deleted. This field only pertains to user and group permissions.
Deleted bool `json:"deleted,omitempty"`
// DisplayName: A displayable name for users, groups or domains.
@@ -1489,7 +1491,6 @@
// user. While new values may be added in future, the following are
// currently possible:
// - file
- // -
// - member
TeamDrivePermissionType string `json:"teamDrivePermissionType,omitempty"`
@@ -1830,8 +1831,8 @@
type TeamDrive struct {
// BackgroundImageFile: An image file and cropping parameters from which
// a background image for this Team Drive is set. This is a write only
- // field that can only be set on a drive.teamdrives.update request that
- // does not set themeId. When specified, all fields of the
+ // field; it can only be set on drive.teamdrives.update requests that
+ // don't set themeId. When specified, all fields of the
// backgroundImageFile must be set.
BackgroundImageFile *TeamDriveBackgroundImageFile `json:"backgroundImageFile,omitempty"`
@@ -1862,8 +1863,8 @@
// color will be set. The set of possible teamDriveThemes can be
// retrieved from a drive.about.get response. When not specified on a
// drive.teamdrives.create request, a random theme is chosen from which
- // the background image and color are set. This is a write only field
- // that can only be set on a request that does not set colorRgb or
+ // the background image and color are set. This is a write-only field;
+ // it can only be set on requests that don't set colorRgb or
// backgroundImageFile.
ThemeId string `json:"themeId,omitempty"`
@@ -1897,32 +1898,32 @@
// TeamDriveBackgroundImageFile: An image file and cropping parameters
// from which a background image for this Team Drive is set. This is a
-// write only field that can only be set on a drive.teamdrives.update
-// request that does not set themeId. When specified, all fields of the
+// write only field; it can only be set on drive.teamdrives.update
+// requests that don't set themeId. When specified, all fields of the
// backgroundImageFile must be set.
type TeamDriveBackgroundImageFile struct {
// Id: The ID of an image file in Drive to use for the background image.
Id string `json:"id,omitempty"`
- // Width: The width of the cropped image in the closed range of 0 to 1,
- // which is the width of the cropped image divided by the width of the
- // entire image. The height is computed by applying a width to height
- // aspect ratio of 80 to 9. The resulting image must be at least 1280
- // pixels wide and 144 pixels high.
+ // Width: The width of the cropped image in the closed range of 0 to 1.
+ // This value represents the width of the cropped image divided by the
+ // width of the entire image. The height is computed by applying a width
+ // to height aspect ratio of 80 to 9. The resulting image must be at
+ // least 1280 pixels wide and 144 pixels high.
Width float64 `json:"width,omitempty"`
// XCoordinate: The X coordinate of the upper left corner of the
// cropping area in the background image. This is a value in the closed
- // range of 0 to 1 which is the horizontal distance from the left side
- // of the entire image to the left side of the cropping area divided by
- // the width of the entire image.
+ // range of 0 to 1. This value represents the horizontal distance from
+ // the left side of the entire image to the left side of the cropping
+ // area divided by the width of the entire image.
XCoordinate float64 `json:"xCoordinate,omitempty"`
// YCoordinate: The Y coordinate of the upper left corner of the
// cropping area in the background image. This is a value in the closed
- // range of 0 to 1 which is the vertical distance from the top side of
- // the entire image to the top side of the cropping area divided by the
- // height of the entire image.
+ // range of 0 to 1. This value represents the vertical distance from the
+ // top side of the entire image to the top side of the cropping area
+ // divided by the height of the entire image.
YCoordinate float64 `json:"yCoordinate,omitempty"`
// ForceSendFields is a list of field names (e.g. "Id") to
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
index 4d1d3d3..9f69936 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
@@ -1,114 +1,219 @@
{
- "documentationLink": "https://firebase.google.com/docs/dynamic-links/",
- "revision": "20170430",
+ "canonicalName": "Firebase Dynamic Links",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/firebase": {
+ "description": "View and administer all your Firebase data and settings"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://firebasedynamiclinks.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "firebasedynamiclinks",
+ "batchPath": "batch",
+ "title": "Firebase Dynamic Links API",
+ "ownerName": "Google",
+ "resources": {
+ "shortLinks": {
+ "methods": {
+ "create": {
+ "flatPath": "v1/shortLinks",
+ "id": "firebasedynamiclinks.shortLinks.create",
+ "path": "v1/shortLinks",
+ "request": {
+ "$ref": "CreateShortDynamicLinkRequest"
+ },
+ "description": "Creates a short Dynamic Link given either a valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nRepeated calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.",
+ "response": {
+ "$ref": "CreateShortDynamicLinkResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {}
+ }
+ }
+ },
+ "v1": {
+ "methods": {
+ "getLinkStats": {
+ "flatPath": "v1/{dynamicLink}/linkStats",
+ "id": "firebasedynamiclinks.getLinkStats",
+ "path": "v1/{dynamicLink}/linkStats",
+ "description": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens.",
+ "response": {
+ "$ref": "DynamicLinkStats"
+ },
+ "parameterOrder": [
+ "dynamicLink"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {
+ "dynamicLink": {
+ "location": "path",
+ "description": "Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz",
+ "type": "string",
+ "required": true
+ },
+ "durationDays": {
+ "format": "int64",
+ "description": "The span of time requested in days.",
+ "type": "string",
+ "location": "query"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "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://firebasedynamiclinks.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Programmatically creates and manages Firebase Dynamic Links.",
+ "servicePath": "",
+ "basePath": "",
"id": "firebasedynamiclinks:v1",
+ "revision": "20170602",
+ "documentationLink": "https://firebase.google.com/docs/dynamic-links/",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "DynamicLinkInfo": {
- "description": "Information about a Dynamic Link.",
- "type": "object",
- "properties": {
- "dynamicLinkDomain": {
- "description": "Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#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": {
- "$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": {
- "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
- "$ref": "SocialMetaTagInfo"
- },
- "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).",
- "$ref": "AndroidInfo"
- },
- "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"
- }
- },
- "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"
- },
- "mt": {
- "description": "iTune media types, including music, podcasts, audiobooks and so on.",
- "type": "string"
- },
- "pt": {
- "description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.",
- "type": "string"
- }
- },
- "id": "ITunesConnectAnalytics"
- },
"SocialMetaTagInfo": {
+ "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
+ "type": "object",
"properties": {
- "socialDescription": {
- "description": "A short description of the link. Optional.",
+ "socialImageLink": {
+ "description": "An image url string. Optional.",
"type": "string"
},
"socialTitle": {
"description": "Title to be displayed. Optional.",
"type": "string"
},
- "socialImageLink": {
- "description": "An image url string. Optional.",
+ "socialDescription": {
+ "description": "A short description of the link. Optional.",
"type": "string"
}
},
- "id": "SocialMetaTagInfo",
- "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
- "type": "object"
+ "id": "SocialMetaTagInfo"
},
- "AndroidInfo": {
+ "DynamicLinkStats": {
+ "description": "Analytics stats of a Dynamic Link for a given timeframe.",
+ "type": "object",
"properties": {
- "androidPackageName": {
- "description": "Android package name of the app.",
- "type": "string"
- },
- "androidMinPackageVersionCode": {
- "description": "Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store.",
- "type": "string"
- },
- "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"
+ "linkEventStats": {
+ "description": "Dynamic Link event stats.",
+ "items": {
+ "$ref": "DynamicLinkEventStat"
+ },
+ "type": "array"
}
},
- "id": "AndroidInfo",
- "description": "Android related attributes to the Dynamic Link.",
- "type": "object"
+ "id": "DynamicLinkStats"
},
"DynamicLinkWarning": {
"description": "Dynamic Links warning messages.",
"type": "object",
"properties": {
+ "warningMessage": {
+ "description": "The warning message to help developers improve their requests.",
+ "type": "string"
+ },
"warningCode": {
"enumDescriptions": [
"Unknown code.",
@@ -174,14 +279,33 @@
],
"description": "The warning code.",
"type": "string"
- },
- "warningMessage": {
- "description": "The warning message to help developers improve their requests.",
- "type": "string"
}
},
"id": "DynamicLinkWarning"
},
+ "AndroidInfo": {
+ "description": "Android related attributes to the Dynamic Link.",
+ "type": "object",
+ "properties": {
+ "androidPackageName": {
+ "description": "Android package name of the app.",
+ "type": "string"
+ },
+ "androidMinPackageVersionCode": {
+ "description": "Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store.",
+ "type": "string"
+ },
+ "androidLink": {
+ "description": "If specified, this overrides the ‘link’ parameter on Android.",
+ "type": "string"
+ },
+ "androidFallbackLink": {
+ "description": "Link to open on Android if the app is not installed.",
+ "type": "string"
+ }
+ },
+ "id": "AndroidInfo"
+ },
"NavigationInfo": {
"description": "Information of navigation behavior.",
"type": "object",
@@ -194,15 +318,9 @@
"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"
@@ -218,11 +336,17 @@
"iosBundleId": {
"description": "iOS bundle ID of the app.",
"type": "string"
+ },
+ "iosFallbackLink": {
+ "description": "Link to open on iOS if the app is not installed.",
+ "type": "string"
+ },
+ "iosAppStoreId": {
+ "description": "iOS App Store ID.",
+ "type": "string"
}
},
- "id": "IosInfo",
- "description": "iOS related attributes to the Dynamic Link..",
- "type": "object"
+ "id": "IosInfo"
},
"AnalyticsInfo": {
"description": "Tracking parameters supported by Dynamic Link.",
@@ -233,8 +357,8 @@
"description": "iTunes Connect App Analytics."
},
"googlePlayAnalytics": {
- "description": "Google Play Campaign Measurements.",
- "$ref": "GooglePlayAnalytics"
+ "$ref": "GooglePlayAnalytics",
+ "description": "Google Play Campaign Measurements."
}
},
"id": "AnalyticsInfo"
@@ -242,8 +366,8 @@
"CreateShortDynamicLinkRequest": {
"properties": {
"dynamicLinkInfo": {
- "$ref": "DynamicLinkInfo",
- "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
+ "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
+ "$ref": "DynamicLinkInfo"
},
"longDynamicLink": {
"description": "Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
@@ -258,17 +382,58 @@
"description": "Request to create a short Dynamic Link.",
"type": "object"
},
+ "DynamicLinkEventStat": {
+ "description": "Dynamic Link event stat.",
+ "type": "object",
+ "properties": {
+ "count": {
+ "format": "int64",
+ "description": "The number of times this event occurred.",
+ "type": "string"
+ },
+ "event": {
+ "enumDescriptions": [
+ "Unspecified type.",
+ "Indicates that an FDL is clicked by users.",
+ "Indicates that an FDL redirects users to fallback link.",
+ "Indicates that an FDL triggers an app install from Play store, currently\nit's impossible to get stats from App store.",
+ "Indicates that the app is opened for the first time after an install\ntriggered by FDLs",
+ "Indicates that the app is opened via an FDL for non-first time."
+ ],
+ "enum": [
+ "DYNAMIC_LINK_EVENT_UNSPECIFIED",
+ "CLICK",
+ "REDIRECT",
+ "APP_INSTALL",
+ "APP_FIRST_OPEN",
+ "APP_RE_OPEN"
+ ],
+ "description": "Link event.",
+ "type": "string"
+ },
+ "platform": {
+ "enumDescriptions": [
+ "Unspecified platform.",
+ "Represents Android platform.\nAll apps and browsers on Android are classfied in this category.",
+ "Represents iOS platform.\nAll apps and browsers on iOS are classfied in this category.",
+ "Represents desktop.\nNote: other platforms like Windows, Blackberry, Amazon fall into this\ncategory."
+ ],
+ "enum": [
+ "DYNAMIC_LINK_PLATFORM_UNSPECIFIED",
+ "ANDROID",
+ "IOS",
+ "DESKTOP"
+ ],
+ "description": "Requested platform.",
+ "type": "string"
+ }
+ },
+ "id": "DynamicLinkEventStat"
+ },
"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"
@@ -276,6 +441,13 @@
"previewLink": {
"description": "Preivew link to show the link flow chart.",
"type": "string"
+ },
+ "warning": {
+ "description": "Information about potential warnings on link creation.",
+ "items": {
+ "$ref": "DynamicLinkWarning"
+ },
+ "type": "array"
}
},
"id": "CreateShortDynamicLinkResponse"
@@ -285,6 +457,8 @@
"type": "object",
"properties": {
"option": {
+ "description": "Suffix option.",
+ "type": "string",
"enumDescriptions": [
"The suffix option is not specified, performs as NOT_GUESSABLE .",
"Short Dynamic Link suffix is a base62 [0-9A-Za-z] encoded string of\na random generated 96 bit random number, which has a length of 17 chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guessing and crawling short Dynamic Links\nthat contain personal identifiable information.",
@@ -294,9 +468,7 @@
"OPTION_UNSPECIFIED",
"UNGUESSABLE",
"SHORT"
- ],
- "description": "Suffix option.",
- "type": "string"
+ ]
}
},
"id": "Suffix"
@@ -305,22 +477,6 @@
"description": "Parameters for Google Play Campaign Measurements.\n[Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)",
"type": "object",
"properties": {
- "utmSource": {
- "description": "Campaign source; used to identify a search engine, newsletter, or other\nsource.",
- "type": "string"
- },
- "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"
- },
- "utmContent": {
- "description": "Campaign content; used for A/B testing and content-targeted ads to\ndifferentiate ads or links that point to the same URL.",
- "type": "string"
- },
"utmMedium": {
"description": "Campaign medium; used to identify a medium such as email or cost-per-click.",
"type": "string"
@@ -328,148 +484,88 @@
"utmTerm": {
"description": "Campaign term; used with paid search to supply the keywords for ads.",
"type": "string"
+ },
+ "utmSource": {
+ "description": "Campaign source; used to identify a search engine, newsletter, or other\nsource.",
+ "type": "string"
+ },
+ "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"
+ },
+ "utmContent": {
+ "description": "Campaign content; used for A/B testing and content-targeted ads to\ndifferentiate ads or links that point to the same URL.",
+ "type": "string"
}
},
"id": "GooglePlayAnalytics"
+ },
+ "DynamicLinkInfo": {
+ "description": "Information about a Dynamic Link.",
+ "type": "object",
+ "properties": {
+ "link": {
+ "description": "The link your app will open, You can specify any URL your app can handle.\nThis link must be a well-formatted URL, be properly URL-encoded, and use\nthe HTTP or HTTPS scheme. See 'link' parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).\n\nRequired.",
+ "type": "string"
+ },
+ "iosInfo": {
+ "description": "iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).",
+ "$ref": "IosInfo"
+ },
+ "socialMetaTagInfo": {
+ "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
+ "$ref": "SocialMetaTagInfo"
+ },
+ "androidInfo": {
+ "$ref": "AndroidInfo",
+ "description": "Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
+ },
+ "navigationInfo": {
+ "description": "Information of navigation behavior of a Firebase Dynamic Links.",
+ "$ref": "NavigationInfo"
+ },
+ "analyticsInfo": {
+ "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).",
+ "$ref": "AnalyticsInfo"
+ },
+ "dynamicLinkDomain": {
+ "description": "Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl\n[Learn more](https://firebase.google.com/docs/dynamic-links/android/receive)\non how to set up Dynamic Link domain associated with your Firebase project.\n\nRequired.",
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "mt": {
+ "description": "iTune media types, including music, podcasts, audiobooks and so on.",
+ "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"
+ },
+ "pt": {
+ "description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.",
+ "type": "string"
+ }
+ },
+ "id": "ITunesConnectAnalytics"
}
},
"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 Dynamic Links",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/firebase": {
- "description": "View and administer all your Firebase data and settings"
- }
- }
- }
- },
- "rootUrl": "https://firebasedynamiclinks.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "firebasedynamiclinks",
- "batchPath": "batch",
- "title": "Firebase Dynamic Links API",
- "ownerName": "Google",
- "resources": {
- "shortLinks": {
- "methods": {
- "create": {
- "request": {
- "$ref": "CreateShortDynamicLinkRequest"
- },
- "description": "Creates a short Dynamic Link given either a valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nRepeated calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.",
- "response": {
- "$ref": "CreateShortDynamicLinkResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/shortLinks",
- "path": "v1/shortLinks",
- "id": "firebasedynamiclinks.shortLinks.create"
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "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": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://firebasedynamiclinks.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Programmatically creates and manages Firebase Dynamic Links.",
- "servicePath": "",
- "basePath": ""
+ "protocol": "rest"
}
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go b/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
index e953dc5..ed1f1dd 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
@@ -57,6 +57,7 @@
}
s := &Service{client: client, BasePath: basePath}
s.ShortLinks = NewShortLinksService(s)
+ s.V1 = NewV1Service(s)
return s, nil
}
@@ -66,6 +67,8 @@
UserAgent string // optional additional User-Agent fragment
ShortLinks *ShortLinksService
+
+ V1 *V1Service
}
func (s *Service) userAgent() string {
@@ -84,6 +87,15 @@
s *Service
}
+func NewV1Service(s *Service) *V1Service {
+ rs := &V1Service{s: s}
+ return rs
+}
+
+type V1Service struct {
+ s *Service
+}
+
// AnalyticsInfo: Tracking parameters supported by Dynamic Link.
type AnalyticsInfo struct {
// GooglePlayAnalytics: Google Play Campaign Measurements.
@@ -246,27 +258,86 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// DynamicLinkEventStat: Dynamic Link event stat.
+type DynamicLinkEventStat struct {
+ // Count: The number of times this event occurred.
+ Count int64 `json:"count,omitempty,string"`
+
+ // Event: Link event.
+ //
+ // Possible values:
+ // "DYNAMIC_LINK_EVENT_UNSPECIFIED" - Unspecified type.
+ // "CLICK" - Indicates that an FDL is clicked by users.
+ // "REDIRECT" - Indicates that an FDL redirects users to fallback
+ // link.
+ // "APP_INSTALL" - Indicates that an FDL triggers an app install from
+ // Play store, currently
+ // it's impossible to get stats from App store.
+ // "APP_FIRST_OPEN" - Indicates that the app is opened for the first
+ // time after an install
+ // triggered by FDLs
+ // "APP_RE_OPEN" - Indicates that the app is opened via an FDL for
+ // non-first time.
+ Event string `json:"event,omitempty"`
+
+ // Platform: Requested platform.
+ //
+ // Possible values:
+ // "DYNAMIC_LINK_PLATFORM_UNSPECIFIED" - Unspecified platform.
+ // "ANDROID" - Represents Android platform.
+ // All apps and browsers on Android are classfied in this category.
+ // "IOS" - Represents iOS platform.
+ // All apps and browsers on iOS are classfied in this category.
+ // "DESKTOP" - Represents desktop.
+ // Note: other platforms like Windows, Blackberry, Amazon fall into
+ // this
+ // category.
+ Platform string `json:"platform,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *DynamicLinkEventStat) MarshalJSON() ([]byte, error) {
+ type noMethod DynamicLinkEventStat
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// DynamicLinkInfo: Information about a Dynamic Link.
type DynamicLinkInfo struct {
// AnalyticsInfo: Parameters used for tracking. See all tracking
// parameters in
// the
- // [documentation](https://firebase.google.com/docs/dynamic-links/and
- // roid#create-a-dynamic-link-programmatically).
+ // [documentation](https://firebase.google.com/docs/dynamic-links/cre
+ // ate-manually).
AnalyticsInfo *AnalyticsInfo `json:"analyticsInfo,omitempty"`
// AndroidInfo: Android related information. See Android related
// parameters in
// the
- // [documentation](https://firebase.google.com/docs/dynamic-links/and
- // roid#create-a-dynamic-link-programmatically).
+ // [documentation](https://firebase.google.com/docs/dynamic-links/cre
+ // ate-manually).
AndroidInfo *AndroidInfo `json:"androidInfo,omitempty"`
// DynamicLinkDomain: Dynamic Links domain that the project owns, e.g.
// abcd.app.goo.gl
// [Learn
- // more](https://firebase.google.com/docs/dynamic-links/android#set-up-fi
- // rebase-and-the-dynamic-links-sdk)
+ // more](https://firebase.google.com/docs/dynamic-links/android/receive)
+ //
// on how to set up Dynamic Link domain associated with your Firebase
// project.
//
@@ -275,8 +346,8 @@
// IosInfo: iOS related information. See iOS related parameters in
// the
- // [documentation](https://firebase.google.com/docs/dynamic-links/ios
- // #create-a-dynamic-link-programmatically).
+ // [documentation](https://firebase.google.com/docs/dynamic-links/cre
+ // ate-manually).
IosInfo *IosInfo `json:"iosInfo,omitempty"`
// Link: The link your app will open, You can specify any URL your app
@@ -285,8 +356,8 @@
// use
// the HTTP or HTTPS scheme. See 'link' parameters in
// the
- // [documentation](https://firebase.google.com/docs/dynamic-links/and
- // roid#create-a-dynamic-link-programmatically).
+ // [documentation](https://firebase.google.com/docs/dynamic-links/cre
+ // ate-manually).
//
// Required.
Link string `json:"link,omitempty"`
@@ -322,6 +393,40 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// DynamicLinkStats: Analytics stats of a Dynamic Link for a given
+// timeframe.
+type DynamicLinkStats struct {
+ // LinkEventStats: Dynamic Link event stats.
+ LinkEventStats []*DynamicLinkEventStat `json:"linkEventStats,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "LinkEventStats") 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. "LinkEventStats") 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 *DynamicLinkStats) MarshalJSON() ([]byte, error) {
+ type noMethod DynamicLinkStats
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// DynamicLinkWarning: Dynamic Links warning messages.
type DynamicLinkWarning struct {
// WarningCode: The warning code.
@@ -798,3 +903,157 @@
// }
}
+
+// method id "firebasedynamiclinks.getLinkStats":
+
+type V1GetLinkStatsCall struct {
+ s *Service
+ dynamicLink string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetLinkStats: Fetches analytics stats of a short Dynamic Link for a
+// given
+// duration. Metrics include number of clicks, redirects, installs,
+// app first opens, and app reopens.
+func (r *V1Service) GetLinkStats(dynamicLink string) *V1GetLinkStatsCall {
+ c := &V1GetLinkStatsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.dynamicLink = dynamicLink
+ return c
+}
+
+// DurationDays sets the optional parameter "durationDays": The span of
+// time requested in days.
+func (c *V1GetLinkStatsCall) DurationDays(durationDays int64) *V1GetLinkStatsCall {
+ c.urlParams_.Set("durationDays", fmt.Sprint(durationDays))
+ 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 *V1GetLinkStatsCall) Fields(s ...googleapi.Field) *V1GetLinkStatsCall {
+ 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 *V1GetLinkStatsCall) IfNoneMatch(entityTag string) *V1GetLinkStatsCall {
+ 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 *V1GetLinkStatsCall) Context(ctx context.Context) *V1GetLinkStatsCall {
+ 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 *V1GetLinkStatsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *V1GetLinkStatsCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{dynamicLink}/linkStats")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "dynamicLink": c.dynamicLink,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "firebasedynamiclinks.getLinkStats" call.
+// Exactly one of *DynamicLinkStats or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *DynamicLinkStats.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 *V1GetLinkStatsCall) Do(opts ...googleapi.CallOption) (*DynamicLinkStats, 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 := &DynamicLinkStats{
+ 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": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens.",
+ // "flatPath": "v1/{dynamicLink}/linkStats",
+ // "httpMethod": "GET",
+ // "id": "firebasedynamiclinks.getLinkStats",
+ // "parameterOrder": [
+ // "dynamicLink"
+ // ],
+ // "parameters": {
+ // "durationDays": {
+ // "description": "The span of time requested in days.",
+ // "format": "int64",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "dynamicLink": {
+ // "description": "Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{dynamicLink}/linkStats",
+ // "response": {
+ // "$ref": "DynamicLinkStats"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/firebase"
+ // ]
+ // }
+
+}
diff --git a/firebaserules/v1/firebaserules-api.json b/firebaserules/v1/firebaserules-api.json
index 0e9637c..6faa0de 100644
--- a/firebaserules/v1/firebaserules-api.json
+++ b/firebaserules/v1/firebaserules-api.json
@@ -1,287 +1,16 @@
{
- "discoveryVersion": "v1",
- "version_module": "True",
- "schemas": {
- "FunctionCall": {
- "description": "Represents a service-defined function call that was invoked during test\nexecution.",
- "type": "object",
- "properties": {
- "args": {
- "description": "The arguments that were provided to the function.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "function": {
- "description": "Name of the function invoked.",
- "type": "string"
- }
- },
- "id": "FunctionCall"
- },
- "File": {
- "description": "`File` containing source content.",
- "type": "object",
- "properties": {
- "fingerprint": {
- "description": "Fingerprint (e.g. github sha) associated with the `File`.",
- "format": "byte",
- "type": "string"
- },
- "name": {
- "description": "File name.",
- "type": "string"
- },
- "content": {
- "description": "Textual Content.",
- "type": "string"
- }
- },
- "id": "File"
- },
- "ListReleasesResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
- "type": "string"
- },
- "releases": {
- "type": "array",
- "items": {
- "$ref": "Release"
- },
- "description": "List of `Release` instances."
- }
- },
- "id": "ListReleasesResponse",
- "description": "The response for FirebaseRulesService.ListReleases."
- },
- "Release": {
- "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.",
- "type": "object",
- "properties": {
- "updateTime": {
- "description": "Time the release was updated.\nOutput only.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "type": "string"
- },
- "rulesetName": {
- "description": "Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must\nexist the `Release` to be created.",
- "type": "string"
- },
- "createTime": {
- "description": "Time the release was created.\nOutput only.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Release"
- },
- "TestRulesetResponse": {
- "description": "The response for FirebaseRulesService.TestRuleset.",
- "type": "object",
- "properties": {
- "testResults": {
- "description": "The set of test results given the test cases in the `TestSuite`.\nThe results will appear in the same order as the test cases appear in the\n`TestSuite`.",
- "type": "array",
- "items": {
- "$ref": "TestResult"
- }
- },
- "issues": {
- "description": "Syntactic and semantic `Source` issues of varying severity. Issues of\n`ERROR` severity will prevent tests from executing.",
- "type": "array",
- "items": {
- "$ref": "Issue"
- }
- }
- },
- "id": "TestRulesetResponse"
- },
- "ListRulesetsResponse": {
- "id": "ListRulesetsResponse",
- "description": "The response for FirebaseRulesService.ListRulesets.",
- "type": "object",
- "properties": {
- "rulesets": {
- "description": "List of `Ruleset` instances.",
- "type": "array",
- "items": {
- "$ref": "Ruleset"
- }
- },
- "nextPageToken": {
- "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
- "type": "string"
- }
- }
- },
- "TestResult": {
- "properties": {
- "functionCalls": {
- "description": "The set of function calls made to service-defined methods.\n\nFunction calls are included in the order in which they are encountered\nduring evaluation, are provided for both mocked and unmocked functions,\nand included on the response regardless of the test `state`.",
- "type": "array",
- "items": {
- "$ref": "FunctionCall"
- }
- },
- "state": {
- "enumDescriptions": [
- "Test state is not set.",
- "Test is a success.",
- "Test is a failure."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "SUCCESS",
- "FAILURE"
- ],
- "description": "State of the test.",
- "type": "string"
- },
- "debugMessages": {
- "description": "Debug messages related to test execution issues encountered during\nevaluation.\n\nDebug messages may be related to too many or too few invocations of\nfunction mocks or to runtime errors that occur during evaluation.\n\nFor example: ```Unable to read variable [name: \"resource\"]```",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "errorPosition": {
- "description": "Position in the `Source` or `Ruleset` where the principle runtime error\noccurs.\n\nEvaluation of an expression may result in an error. Rules are deny by\ndefault, so a `DENY` expectation when an error is generated is valid.\nWhen there is a `DENY` with an error, the `SourcePosition` is returned.\n\nE.g. `error_position { line: 19 column: 37 }`",
- "$ref": "SourcePosition"
- }
- },
- "id": "TestResult",
- "description": "Test result message containing the state of the test as well as a\ndescription and source position for test failures.",
- "type": "object"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Source": {
- "description": "`Source` is one or more `File` messages comprising a logical set of rules.",
- "type": "object",
- "properties": {
- "files": {
- "description": "`File` set constituting the `Source` bundle.",
- "type": "array",
- "items": {
- "$ref": "File"
- }
- }
- },
- "id": "Source"
- },
- "SourcePosition": {
- "type": "object",
- "properties": {
- "line": {
- "description": "Line number of the source fragment. 1-based.",
- "format": "int32",
- "type": "integer"
- },
- "column": {
- "description": "First column on the source line associated with the source fragment.",
- "format": "int32",
- "type": "integer"
- },
- "fileName": {
- "description": "Name of the `File`.",
- "type": "string"
- }
- },
- "id": "SourcePosition",
- "description": "Position in the `Source` content including its line, column number, and an\nindex of the `File` in the `Source` message. Used for debug purposes."
- },
- "Ruleset": {
- "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\nOutput only.",
- "type": "string"
- },
- "source": {
- "$ref": "Source",
- "description": "`Source` for the `Ruleset`."
- },
- "createTime": {
- "description": "Time the `Ruleset` was created.\nOutput only.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Ruleset"
- },
- "Issue": {
- "description": "Issues include warnings, errors, and deprecation notices.",
- "type": "object",
- "properties": {
- "sourcePosition": {
- "$ref": "SourcePosition",
- "description": "Position of the issue in the `Source`."
- },
- "severity": {
- "enum": [
- "SEVERITY_UNSPECIFIED",
- "DEPRECATION",
- "WARNING",
- "ERROR"
- ],
- "description": "The severity of the issue.",
- "type": "string",
- "enumDescriptions": [
- "An unspecified severity.",
- "Deprecation issue for statements and method that may no longer be\nsupported or maintained.",
- "Warnings such as: unused variables.",
- "Errors such as: unmatched curly braces or variable redefinition."
- ]
- },
- "description": {
- "description": "Short error description.",
- "type": "string"
- }
- },
- "id": "Issue"
- },
- "TestRulesetRequest": {
- "description": "The request for FirebaseRulesService.TestRuleset.",
- "type": "object",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`."
- }
- },
- "id": "TestRulesetRequest"
- }
- },
- "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 Rules",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
"https://www.googleapis.com/auth/firebase": {
"description": "View and administer all your Firebase data and settings"
},
"https://www.googleapis.com/auth/firebase.readonly": {
"description": "View all your Firebase data and settings"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -329,120 +58,21 @@
"resources": {
"rulesets": {
"methods": {
- "get": {
- "description": "Get a `Ruleset` by name including the full `Source` contents.",
- "response": {
- "$ref": "Ruleset"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
- "parameters": {
- "name": {
- "description": "Resource name for the ruleset to get.\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.get"
- },
- "list": {
- "response": {
- "$ref": "ListRulesetsResponse"
- },
- "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": {
- "filter": {
- "location": "query",
- "description": "`Ruleset` filter. The list method supports filters with restrictions on\n`Ruleset.name`.\n\nFilters on `Ruleset.create_time` should use the `date` function which\nparses strings that conform to the RFC 3339 date/time specifications.\n\nExample: `create_time \u003e date(\"2017-01-01\") AND name=UUID-*`",
- "type": "string"
- },
- "name": {
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "Next page token for loading the next batch of `Ruleset` instances.",
- "type": "string",
- "location": "query"
- },
- "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}/rulesets",
- "path": "v1/{+name}/rulesets",
- "id": "firebaserules.projects.rulesets.list",
- "description": "List `Ruleset` metadata only and optionally filter the results by `Ruleset`\nname.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with\nGetRuleset."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Ruleset"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/projects/{projectsId}/rulesets",
- "id": "firebaserules.projects.rulesets.create",
- "path": "v1/{+name}/rulesets",
- "request": {
- "$ref": "Ruleset"
- },
- "description": "Create a `Ruleset` from `Source`.\n\nThe `Ruleset` is given a unique generated name which is returned to the\ncaller. `Source` containing syntactic or semantics errors will result in an\nerror response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset."
- },
"delete": {
"httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "name"
+ ],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/rulesets/[^/]+$",
- "location": "path",
"description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/rulesets/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -453,19 +83,147 @@
"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."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Ruleset"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the ruleset to get.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/rulesets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
+ ],
+ "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
+ "id": "firebaserules.projects.rulesets.get",
+ "path": "v1/{+name}",
+ "description": "Get a `Ruleset` by name including the full `Source` contents."
+ },
+ "list": {
+ "description": "List `Ruleset` metadata only and optionally filter the results by `Ruleset`\nname.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with\nGetRuleset.",
+ "response": {
+ "$ref": "ListRulesetsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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"
+ },
+ "filter": {
+ "location": "query",
+ "description": "`Ruleset` filter. The list method supports filters with restrictions on\n`Ruleset.name`.\n\nFilters on `Ruleset.create_time` should use the `date` function which\nparses strings that conform to the RFC 3339 date/time specifications.\n\nExample: `create_time \u003e date(\"2017-01-01\") AND name=UUID-*`",
+ "type": "string"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Next page token for loading the next batch of `Ruleset` instances.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
+ ],
+ "flatPath": "v1/projects/{projectsId}/rulesets",
+ "path": "v1/{+name}/rulesets",
+ "id": "firebaserules.projects.rulesets.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "Ruleset"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`"
+ }
+ },
+ "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",
+ "request": {
+ "$ref": "Ruleset"
+ },
+ "description": "Create a `Ruleset` from `Source`.\n\nThe `Ruleset` is given a unique generated name which is returned to the\ncaller. `Source` containing syntactic or semantics errors will result in an\nerror response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset."
}
}
},
"releases": {
"methods": {
+ "create": {
+ "id": "firebaserules.projects.releases.create",
+ "path": "v1/{+name}/releases",
+ "request": {
+ "$ref": "Release"
+ },
+ "description": "Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Release"
+ },
+ "parameters": {
+ "name": {
+ "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "flatPath": "v1/projects/{projectsId}/releases"
+ },
"delete": {
+ "httpMethod": "DELETE",
"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}`",
@@ -480,17 +238,22 @@
"https://www.googleapis.com/auth/firebase"
],
"flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "path": "v1/{+name}",
"id": "firebaserules.projects.releases.delete",
+ "path": "v1/{+name}",
"description": "Delete a `Release` by resource name."
},
"get": {
+ "parameterOrder": [
+ "name"
+ ],
"httpMethod": "GET",
"response": {
"$ref": "Release"
},
- "parameterOrder": [
- "name"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
],
"parameters": {
"name": {
@@ -501,27 +264,23 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
"flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "id": "firebaserules.projects.releases.get",
"path": "v1/{+name}",
+ "id": "firebaserules.projects.releases.get",
"description": "Get a `Release` by name."
},
"list": {
- "id": "firebaserules.projects.releases.list",
+ "flatPath": "v1/projects/{projectsId}/releases",
"path": "v1/{+name}/releases",
+ "id": "firebaserules.projects.releases.list",
"description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name, `Ruleset` name, `TestSuite` name, or any\ncombination thereof.",
- "httpMethod": "GET",
"response": {
"$ref": "ListReleasesResponse"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase",
@@ -529,11 +288,11 @@
],
"parameters": {
"name": {
- "required": true,
- "type": "string",
"pattern": "^projects/[^/]+$",
"location": "path",
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`"
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
+ "required": true,
+ "type": "string"
},
"pageToken": {
"location": "query",
@@ -551,66 +310,36 @@
"description": "`Release` filter. The list method supports filters with restrictions on the\n`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.\n\nExample 1: A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2: A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filter parameters refer to the search filters are\nrelative to the project. Fully qualified prefixed may also be used. e.g.\n`test_suite_name=projects/foo/testsuites/uuid1`",
"type": "string"
}
- },
- "flatPath": "v1/projects/{projectsId}/releases"
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Release"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {
- "name": {
- "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "id": "firebaserules.projects.releases.update",
- "path": "v1/{+name}",
- "description": "Update a `Release`.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method.",
- "request": {
- "$ref": "Release"
}
},
- "create": {
+ "update": {
"response": {
"$ref": "Release"
},
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "httpMethod": "PUT",
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/releases/.+$",
"location": "path",
- "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`",
+ "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/[^/]+$"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
- "flatPath": "v1/projects/{projectsId}/releases",
- "path": "v1/{+name}/releases",
- "id": "firebaserules.projects.releases.create",
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "path": "v1/{+name}",
+ "id": "firebaserules.projects.releases.update",
"request": {
"$ref": "Release"
},
- "description": "Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method."
+ "description": "Update a `Release`.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method."
}
}
}
@@ -618,11 +347,26 @@
}
},
"parameters": {
- "pp": {
+ "key": {
"location": "query",
- "description": "Pretty-print response.",
+ "description": "API key. Your API 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": {
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
@@ -635,19 +379,14 @@
"location": "query"
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
+ "default": "true",
"location": "query"
},
"fields": {
@@ -655,7 +394,14 @@
"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"
@@ -664,16 +410,20 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "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": [
@@ -681,37 +431,393 @@
"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": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
}
},
"version": "v1",
"baseUrl": "https://firebaserules.googleapis.com/",
- "servicePath": "",
"description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
"kind": "discovery#restDescription",
+ "servicePath": "",
"basePath": "",
- "revision": "20170418",
"documentationLink": "https://firebase.google.com/docs/storage/security",
- "id": "firebaserules:v1"
+ "revision": "20170523",
+ "id": "firebaserules:v1",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "schemas": {
+ "SourcePosition": {
+ "type": "object",
+ "properties": {
+ "column": {
+ "type": "integer",
+ "description": "First column on the source line associated with the source fragment.",
+ "format": "int32"
+ },
+ "fileName": {
+ "description": "Name of the `File`.",
+ "type": "string"
+ },
+ "line": {
+ "type": "integer",
+ "description": "Line number of the source fragment. 1-based.",
+ "format": "int32"
+ }
+ },
+ "id": "SourcePosition",
+ "description": "Position in the `Source` content including its line, column number, and an\nindex of the `File` in the `Source` message. Used for debug purposes."
+ },
+ "TestCase": {
+ "description": "`TestCase` messages provide the request context and an expectation as to\nwhether the given context will be allowed or denied. Test cases may specify\nthe `request`, `resource`, and `function_mocks` to mock a function call to\na service-provided function.\n\nThe `request` object represents context present at request-time.\n\nThe `resource` is the value of the target resource as it appears in\npersistent storage before the request is executed.",
+ "type": "object",
+ "properties": {
+ "resource": {
+ "description": "Optional resource value as it appears in persistent storage before the\nrequest is fulfilled.\n\nThe resource type depends on the `request.path` value.",
+ "type": "any"
+ },
+ "functionMocks": {
+ "description": "Optional function mocks for service-defined functions. If not set, any\nservice defined function is expected to return an error, which may or may\nnot influence the test outcome.",
+ "type": "array",
+ "items": {
+ "$ref": "FunctionMock"
+ }
+ },
+ "expectation": {
+ "description": "Test expectation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified expectation.",
+ "Expect an allowed result.",
+ "Expect a denied result."
+ ],
+ "enum": [
+ "EXPECTATION_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ]
+ },
+ "request": {
+ "description": "Request context.\n\nThe exact format of the request context is service-dependent. See the\nappropriate service documentation for information about the supported\nfields and types on the request. Minimally, all services support the\nfollowing fields and types:\n\nRequest field | Type\n---------------|-----------------\nauth.uid | `string`\nauth.token | `map\u003cstring, string\u003e`\nheaders | `map\u003cstring, string\u003e`\nmethod | `string`\nparams | `map\u003cstring, string\u003e`\npath | `string`\ntime | `google.protobuf.Timestamp`\n\nIf the request value is not well-formed for the service, the request will\nbe rejected as an invalid argument.",
+ "type": "any"
+ }
+ },
+ "id": "TestCase"
+ },
+ "Issue": {
+ "properties": {
+ "description": {
+ "description": "Short error description.",
+ "type": "string"
+ },
+ "sourcePosition": {
+ "$ref": "SourcePosition",
+ "description": "Position of the issue in the `Source`."
+ },
+ "severity": {
+ "enum": [
+ "SEVERITY_UNSPECIFIED",
+ "DEPRECATION",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "The severity of the issue.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified severity.",
+ "Deprecation issue for statements and method that may no longer be\nsupported or maintained.",
+ "Warnings such as: unused variables.",
+ "Errors such as: unmatched curly braces or variable redefinition."
+ ]
+ }
+ },
+ "id": "Issue",
+ "description": "Issues include warnings, errors, and deprecation notices.",
+ "type": "object"
+ },
+ "TestRulesetRequest": {
+ "description": "The request for FirebaseRulesService.TestRuleset.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`.",
+ "$ref": "Source"
+ },
+ "testSuite": {
+ "$ref": "TestSuite",
+ "description": "Inline `TestSuite` to run."
+ }
+ },
+ "id": "TestRulesetRequest"
+ },
+ "Ruleset": {
+ "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\nOutput only.",
+ "type": "string"
+ },
+ "source": {
+ "description": "`Source` for the `Ruleset`.",
+ "$ref": "Source"
+ },
+ "createTime": {
+ "description": "Time the `Ruleset` was created.\nOutput only.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Ruleset"
+ },
+ "File": {
+ "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",
+ "type": "string"
+ },
+ "name": {
+ "description": "File name.",
+ "type": "string"
+ }
+ },
+ "id": "File"
+ },
+ "ListReleasesResponse": {
+ "description": "The response for FirebaseRulesService.ListReleases.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
+ "type": "string"
+ },
+ "releases": {
+ "description": "List of `Release` instances.",
+ "type": "array",
+ "items": {
+ "$ref": "Release"
+ }
+ }
+ },
+ "id": "ListReleasesResponse"
+ },
+ "FunctionCall": {
+ "description": "Represents a service-defined function call that was invoked during test\nexecution.",
+ "type": "object",
+ "properties": {
+ "function": {
+ "description": "Name of the function invoked.",
+ "type": "string"
+ },
+ "args": {
+ "description": "The arguments that were provided to the function.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "id": "FunctionCall"
+ },
+ "Release": {
+ "properties": {
+ "updateTime": {
+ "description": "Time the release was updated.\nOutput only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
+ "type": "string"
+ },
+ "rulesetName": {
+ "description": "Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must\nexist the `Release` to be created.",
+ "type": "string"
+ },
+ "createTime": {
+ "type": "string",
+ "description": "Time the release was created.\nOutput only.",
+ "format": "google-datetime"
+ }
+ },
+ "id": "Release",
+ "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.",
+ "type": "object"
+ },
+ "TestRulesetResponse": {
+ "description": "The response for FirebaseRulesService.TestRuleset.",
+ "type": "object",
+ "properties": {
+ "testResults": {
+ "type": "array",
+ "items": {
+ "$ref": "TestResult"
+ },
+ "description": "The set of test results given the test cases in the `TestSuite`.\nThe results will appear in the same order as the test cases appear in the\n`TestSuite`."
+ },
+ "issues": {
+ "description": "Syntactic and semantic `Source` issues of varying severity. Issues of\n`ERROR` severity will prevent tests from executing.",
+ "type": "array",
+ "items": {
+ "$ref": "Issue"
+ }
+ }
+ },
+ "id": "TestRulesetResponse"
+ },
+ "ListRulesetsResponse": {
+ "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"
+ }
+ }
+ },
+ "id": "ListRulesetsResponse",
+ "description": "The response for FirebaseRulesService.ListRulesets.",
+ "type": "object"
+ },
+ "TestResult": {
+ "description": "Test result message containing the state of the test as well as a\ndescription and source position for test failures.",
+ "type": "object",
+ "properties": {
+ "errorPosition": {
+ "$ref": "SourcePosition",
+ "description": "Position in the `Source` or `Ruleset` where the principle runtime error\noccurs.\n\nEvaluation of an expression may result in an error. Rules are deny by\ndefault, so a `DENY` expectation when an error is generated is valid.\nWhen there is a `DENY` with an error, the `SourcePosition` is returned.\n\nE.g. `error_position { line: 19 column: 37 }`"
+ },
+ "functionCalls": {
+ "description": "The set of function calls made to service-defined methods.\n\nFunction calls are included in the order in which they are encountered\nduring evaluation, are provided for both mocked and unmocked functions,\nand included on the response regardless of the test `state`.",
+ "type": "array",
+ "items": {
+ "$ref": "FunctionCall"
+ }
+ },
+ "state": {
+ "enumDescriptions": [
+ "Test state is not set.",
+ "Test is a success.",
+ "Test is a failure."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "SUCCESS",
+ "FAILURE"
+ ],
+ "description": "State of the test.",
+ "type": "string"
+ },
+ "debugMessages": {
+ "description": "Debug messages related to test execution issues encountered during\nevaluation.\n\nDebug messages may be related to too many or too few invocations of\nfunction mocks or to runtime errors that occur during evaluation.\n\nFor example: ```Unable to read variable [name: \"resource\"]```",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestResult"
+ },
+ "Arg": {
+ "description": "Arg matchers for the mock function.",
+ "type": "object",
+ "properties": {
+ "exactValue": {
+ "description": "Argument exactly matches value provided.",
+ "type": "any"
+ },
+ "anyValue": {
+ "$ref": "Empty",
+ "description": "Argument matches any value provided."
+ }
+ },
+ "id": "Arg"
+ },
+ "TestSuite": {
+ "id": "TestSuite",
+ "description": "`TestSuite` is a collection of `TestCase` instances that validate the logical\ncorrectness of a `Ruleset`. The `TestSuite` may be referenced in-line within\na `TestRuleset` invocation or as part of a `Release` object as a pre-release\ncheck.",
+ "type": "object",
+ "properties": {
+ "testCases": {
+ "description": "Collection of test cases associated with the `TestSuite`.",
+ "type": "array",
+ "items": {
+ "$ref": "TestCase"
+ }
+ }
+ }
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "FunctionMock": {
+ "description": "Mock function definition.\n\nMocks must refer to a function declared by the target service. The type of\nthe function args and result will be inferred at test time. If either the\narg or result values are not compatible with function type declaration, the\nrequest will be considered invalid.\n\nMore than one `FunctionMock` may be provided for a given function name so\nlong as the `Arg` matchers are distinct. There may be only one function\nfor a given overload where all `Arg` values are `Arg.any_value`.",
+ "type": "object",
+ "properties": {
+ "args": {
+ "description": "The list of `Arg` values to match. The order in which the arguments are\nprovided is the order in which they must appear in the function\ninvocation.",
+ "type": "array",
+ "items": {
+ "$ref": "Arg"
+ }
+ },
+ "function": {
+ "description": "The name of the function.\n\nThe function name must match one provided by a service declaration.",
+ "type": "string"
+ },
+ "result": {
+ "$ref": "Result",
+ "description": "The mock result of the function call."
+ }
+ },
+ "id": "FunctionMock"
+ },
+ "Source": {
+ "id": "Source",
+ "description": "`Source` is one or more `File` messages comprising a logical set of rules.",
+ "type": "object",
+ "properties": {
+ "files": {
+ "type": "array",
+ "items": {
+ "$ref": "File"
+ },
+ "description": "`File` set constituting the `Source` bundle."
+ }
+ }
+ },
+ "Result": {
+ "description": "Possible result values from the function mock invocation.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The result is an actual value. The type of the value must match that\nof the type declared by the service.",
+ "type": "any"
+ },
+ "undefined": {
+ "$ref": "Empty",
+ "description": "The result is undefined, meaning the result could not be computed."
+ }
+ },
+ "id": "Result"
+ }
+ },
+ "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/firebaserules/v1/firebaserules-gen.go b/firebaserules/v1/firebaserules-gen.go
index b7802b1..2292dea 100644
--- a/firebaserules/v1/firebaserules-gen.go
+++ b/firebaserules/v1/firebaserules-gen.go
@@ -114,6 +114,37 @@
s *Service
}
+// Arg: Arg matchers for the mock function.
+type Arg struct {
+ // AnyValue: Argument matches any value provided.
+ AnyValue *Empty `json:"anyValue,omitempty"`
+
+ // ExactValue: Argument exactly matches value provided.
+ ExactValue interface{} `json:"exactValue,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AnyValue") 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. "AnyValue") 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 *Arg) MarshalJSON() ([]byte, error) {
+ type noMethod Arg
+ raw := noMethod(*s)
+ 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
@@ -200,6 +231,60 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// FunctionMock: Mock function definition.
+//
+// Mocks must refer to a function declared by the target service. The
+// type of
+// the function args and result will be inferred at test time. If either
+// the
+// arg or result values are not compatible with function type
+// declaration, the
+// request will be considered invalid.
+//
+// More than one `FunctionMock` may be provided for a given function
+// name so
+// long as the `Arg` matchers are distinct. There may be only one
+// function
+// for a given overload where all `Arg` values are `Arg.any_value`.
+type FunctionMock struct {
+ // Args: The list of `Arg` values to match. The order in which the
+ // arguments are
+ // provided is the order in which they must appear in the
+ // function
+ // invocation.
+ Args []*Arg `json:"args,omitempty"`
+
+ // Function: The name of the function.
+ //
+ // The function name must match one provided by a service declaration.
+ Function string `json:"function,omitempty"`
+
+ // Result: The mock result of the function call.
+ Result *Result `json:"result,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 *FunctionMock) MarshalJSON() ([]byte, error) {
+ type noMethod FunctionMock
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Issue: Issues include warnings, errors, and deprecation notices.
type Issue struct {
// Description: Short error description.
@@ -401,6 +486,40 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// Result: Possible result values from the function mock invocation.
+type Result struct {
+ // Undefined: The result is undefined, meaning the result could not be
+ // computed.
+ Undefined *Empty `json:"undefined,omitempty"`
+
+ // Value: The result is an actual value. The type of the value must
+ // match that
+ // of the type declared by the service.
+ Value interface{} `json:"value,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Undefined") 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. "Undefined") 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 *Result) MarshalJSON() ([]byte, error) {
+ type noMethod Result
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Ruleset: `Ruleset` is an immutable copy of `Source` with a globally
// unique identifier
// and a creation time.
@@ -511,6 +630,90 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// TestCase: `TestCase` messages provide the request context and an
+// expectation as to
+// whether the given context will be allowed or denied. Test cases may
+// specify
+// the `request`, `resource`, and `function_mocks` to mock a function
+// call to
+// a service-provided function.
+//
+// The `request` object represents context present at request-time.
+//
+// The `resource` is the value of the target resource as it appears
+// in
+// persistent storage before the request is executed.
+type TestCase struct {
+ // Expectation: Test expectation.
+ //
+ // Possible values:
+ // "EXPECTATION_UNSPECIFIED" - Unspecified expectation.
+ // "ALLOW" - Expect an allowed result.
+ // "DENY" - Expect a denied result.
+ Expectation string `json:"expectation,omitempty"`
+
+ // FunctionMocks: Optional function mocks for service-defined functions.
+ // If not set, any
+ // service defined function is expected to return an error, which may or
+ // may
+ // not influence the test outcome.
+ FunctionMocks []*FunctionMock `json:"functionMocks,omitempty"`
+
+ // Request: Request context.
+ //
+ // The exact format of the request context is service-dependent. See
+ // the
+ // appropriate service documentation for information about the
+ // supported
+ // fields and types on the request. Minimally, all services support
+ // the
+ // following fields and types:
+ //
+ // Request field | Type
+ // ---------------|-----------------
+ // auth.uid | `string`
+ // auth.token | `map<string, string>`
+ // headers | `map<string, string>`
+ // method | `string`
+ // params | `map<string, string>`
+ // path | `string`
+ // time | `google.protobuf.Timestamp`
+ //
+ // If the request value is not well-formed for the service, the request
+ // will
+ // be rejected as an invalid argument.
+ Request interface{} `json:"request,omitempty"`
+
+ // Resource: Optional resource value as it appears in persistent storage
+ // before the
+ // request is fulfilled.
+ //
+ // The resource type depends on the `request.path` value.
+ Resource interface{} `json:"resource,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Expectation") 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. "Expectation") 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 *TestCase) MarshalJSON() ([]byte, error) {
+ type noMethod TestCase
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// TestResult: Test result message containing the state of the test as
// well as a
// description and source position for test failures.
@@ -590,6 +793,9 @@
// `Ruleset`.
Source *Source `json:"source,omitempty"`
+ // TestSuite: Inline `TestSuite` to run.
+ TestSuite *TestSuite `json:"testSuite,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "Source") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -655,6 +861,40 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// TestSuite: `TestSuite` is a collection of `TestCase` instances that
+// validate the logical
+// correctness of a `Ruleset`. The `TestSuite` may be referenced in-line
+// within
+// a `TestRuleset` invocation or as part of a `Release` object as a
+// pre-release
+// check.
+type TestSuite struct {
+ // TestCases: Collection of test cases associated with the `TestSuite`.
+ TestCases []*TestCase `json:"testCases,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "TestCases") 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. "TestCases") 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 *TestSuite) MarshalJSON() ([]byte, error) {
+ type noMethod TestSuite
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// method id "firebaserules.projects.test":
type ProjectsTestCall struct {
diff --git a/genomics/v1/genomics-api.json b/genomics/v1/genomics-api.json
index c2033e5..16eb225 100644
--- a/genomics/v1/genomics-api.json
+++ b/genomics/v1/genomics-api.json
@@ -1,1179 +1,36 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/genomics": {
- "description": "View and manage Genomics data"
- },
- "https://www.googleapis.com/auth/bigquery": {
- "description": "View and manage your data in Google BigQuery"
- },
- "https://www.googleapis.com/auth/devstorage.read_write": {
- "description": "Manage your data in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/genomics.readonly": {
- "description": "View Genomics data"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "Upload, process, query, and search Genomics data in the cloud.",
- "servicePath": "",
- "rootUrl": "https://genomics.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
"name": "genomics",
"batchPath": "batch",
- "documentationLink": "https://cloud.google.com/genomics",
"id": "genomics:v1",
- "revision": "20170509",
+ "documentationLink": "https://cloud.google.com/genomics",
+ "revision": "20170603",
"title": "Genomics API",
"ownerName": "Google",
"discoveryVersion": "v1",
"resources": {
- "variantsets": {
- "methods": {
- "search": {
- "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",
- "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)."
- },
- "patch": {
- "flatPath": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.patch",
- "path": "v1/variantsets/{variantSetId}",
- "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"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "variantSetId"
- ],
- "response": {
- "$ref": "VariantSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "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": {
- "description": "The ID of the variant to be updated (must already exist).",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "get": {
- "flatPath": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.get",
- "path": "v1/variantsets/{variantSetId}",
- "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": {
- "location": "path",
- "description": "Required. The ID of the variant set.",
- "required": true,
- "type": "string"
- }
- }
- },
- "delete": {
- "id": "genomics.variantsets.delete",
- "path": "v1/variantsets/{variantSetId}",
- "description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "variantSetId": {
- "description": "The ID of the variant set to be deleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/variantsets/{variantSetId}"
- },
- "create": {
- "flatPath": "v1/variantsets",
- "path": "v1/variantsets",
- "id": "genomics.variantsets.create",
- "request": {
- "$ref": "VariantSet"
- },
- "description": "Creates a new variant set.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe provided variant set must have a valid `datasetId` set - all other\nfields are optional. Note that the `id` field will be ignored, as this is\nassigned by the server.",
- "response": {
- "$ref": "VariantSet"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "export": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "variantSetId": {
- "required": true,
- "type": "string",
- "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."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variantsets/{variantSetId}:export",
- "path": "v1/variantsets/{variantSetId}:export",
- "id": "genomics.variantsets.export",
- "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)"
- }
- }
- },
- "annotations": {
- "methods": {
- "delete": {
- "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "annotationId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the annotation to be deleted."
- }
- },
- "flatPath": "v1/annotations/{annotationId}",
- "path": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.delete"
- },
- "create": {
- "request": {
- "$ref": "Annotation"
- },
- "description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.",
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations",
- "path": "v1/annotations",
- "id": "genomics.annotations.create"
- },
- "batchCreate": {
- "description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.",
- "request": {
- "$ref": "BatchCreateAnnotationsRequest"
- },
- "response": {
- "$ref": "BatchCreateAnnotationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/annotations:batchCreate",
- "path": "v1/annotations:batchCreate",
- "id": "genomics.annotations.batchCreate"
- },
- "search": {
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchAnnotationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/annotations/search",
- "id": "genomics.annotations.search",
- "path": "v1/annotations/search"
- },
- "get": {
- "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set.",
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "GET",
- "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}",
- "path": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.get"
- },
- "update": {
- "path": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.update",
- "request": {
- "$ref": "Annotation"
- },
- "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset.",
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "annotationId": {
- "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}"
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "flatPath": "v1/operations/{operationsId}: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": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$"
- }
- }
- },
- "list": {
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "genomics.operations.list",
- "description": "Lists operations that match the specified filter in the request.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "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": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "id": "genomics.operations.get",
- "path": "v1/{+name}"
- }
- }
- },
- "referencesets": {
- "methods": {
- "search": {
- "request": {
- "$ref": "SearchReferenceSetsRequest"
- },
- "description": "Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)",
- "response": {
- "$ref": "SearchReferenceSetsResponse"
- },
- "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/referencesets/search",
- "path": "v1/referencesets/search",
- "id": "genomics.referencesets.search"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ReferenceSet"
- },
- "parameterOrder": [
- "referenceSetId"
- ],
- "parameters": {
- "referenceSetId": {
- "location": "path",
- "description": "The ID of the reference set.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/referencesets/{referenceSetId}",
- "id": "genomics.referencesets.get",
- "path": "v1/referencesets/{referenceSetId}",
- "description": "Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83)."
- }
- }
- },
- "callsets": {
- "methods": {
- "delete": {
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.delete",
- "description": "Deletes a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "callSetId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "callSetId": {
- "description": "The ID of the call set to be deleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/callsets/{callSetId}"
- },
- "search": {
- "id": "genomics.callsets.search",
- "path": "v1/callsets/search",
- "request": {
- "$ref": "SearchCallSetsRequest"
- },
- "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).",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchCallSetsResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/callsets/search"
- },
- "patch": {
- "description": "Updates a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "CallSet"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "callSetId"
- ],
- "response": {
- "$ref": "CallSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "callSetId": {
- "location": "path",
- "description": "The ID of the call set to be updated.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.patch",
- "path": "v1/callsets/{callSetId}"
- },
- "get": {
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [
- "callSetId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "callSetId": {
- "location": "path",
- "description": "The ID of the call set.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.get",
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/callsets",
- "path": "v1/callsets",
- "id": "genomics.callsets.create",
- "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "request": {
- "$ref": "CallSet"
- }
- }
- }
- },
- "reads": {
- "methods": {
- "search": {
- "flatPath": "v1/reads/search",
- "path": "v1/reads/search",
- "id": "genomics.reads.search",
- "request": {
- "$ref": "SearchReadsRequest"
- },
- "description": "Gets a list of reads for one or more read group sets.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nReads search operates over a genomic coordinate space of reference sequence\n& position defined over the reference sequences to which the requested\nread group sets are aligned.\n\nIf a target positional range is specified, search returns all reads whose\nalignment to the reference genome overlap the range. A query which\nspecifies only read group set IDs yields all reads in those read group\nsets, including unmapped reads.\n\nAll reads returned (including reads on subsequent pages) are ordered by\ngenomic coordinate (by reference sequence, then position). Reads with\nequivalent genomic coordinates are returned in an unspecified order. This\norder is consistent, such that two queries for the same content (regardless\nof page size) yield reads in the same order across their respective streams\nof paginated responses.\n\nImplements\n[GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).",
- "response": {
- "$ref": "SearchReadsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ]
- }
- }
- },
- "readgroupsets": {
- "methods": {
- "import": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/readgroupsets:import",
- "path": "v1/readgroupsets:import",
- "id": "genomics.readgroupsets.import",
- "request": {
- "$ref": "ImportReadGroupSetsRequest"
- },
- "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)"
- },
- "delete": {
- "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"
- ],
- "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)"
- },
- "export": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "readGroupSetId": {
- "description": "Required. The ID of the read group set to export. The caller must have\nREAD access to this read group set.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/readgroupsets/{readGroupSetId}:export",
- "path": "v1/readgroupsets/{readGroupSetId}:export",
- "id": "genomics.readgroupsets.export",
- "request": {
- "$ref": "ExportReadGroupSetRequest"
- },
- "description": "Exports a read group set to a BAM file in Google Cloud Storage.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nNote that currently there may be some differences between exported BAM\nfiles and the original BAM file at the time of import. See\nImportReadGroupSets\nfor caveats."
- },
- "search": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchReadGroupSetsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/readgroupsets/search",
- "id": "genomics.readgroupsets.search",
- "path": "v1/readgroupsets/search",
- "description": "Searches for read group sets matching the criteria.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).",
- "request": {
- "$ref": "SearchReadGroupSetsRequest"
- }
- },
- "get": {
- "response": {
- "$ref": "ReadGroupSet"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "readGroupSetId": {
- "location": "path",
- "description": "The ID of the read group set.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "path": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.get",
- "description": "Gets a read group set by ID.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "patch": {
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "path": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.patch",
- "request": {
- "$ref": "ReadGroupSet"
- },
- "description": "Updates a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "response": {
- "$ref": "ReadGroupSet"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "readGroupSetId": {
- "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "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"
- ]
- }
- },
- "resources": {
- "coveragebuckets": {
- "methods": {
- "list": {
- "id": "genomics.readgroupsets.coveragebuckets.list",
- "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
- "description": "Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListCoverageBucketsResponse"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "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": {
- "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",
- "location": "query"
- },
- "readGroupSetId": {
- "location": "path",
- "description": "Required. The ID of the read group set over which coverage is requested.",
- "required": true,
- "type": "string"
- },
- "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": {
- "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
- "type": "string",
- "location": "query"
- },
- "end": {
- "location": "query",
- "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"
- }
- },
- "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets"
- }
- }
- }
- }
- },
- "variants": {
- "methods": {
- "create": {
- "response": {
- "$ref": "Variant"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variants",
- "path": "v1/variants",
- "id": "genomics.variants.create",
- "request": {
- "$ref": "Variant"
- },
- "description": "Creates a new variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "search": {
- "description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).",
- "request": {
- "$ref": "SearchVariantsRequest"
- },
- "response": {
- "$ref": "SearchVariantsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/variants/search",
- "path": "v1/variants/search",
- "id": "genomics.variants.search"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "variantId"
- ],
- "response": {
- "$ref": "Variant"
- },
- "parameters": {
- "variantId": {
- "location": "path",
- "description": "The ID of the variant to be updated.",
- "required": true,
- "type": "string"
- },
- "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."
- },
- "get": {
- "description": "Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Variant"
- },
- "parameterOrder": [
- "variantId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "variantId": {
- "location": "path",
- "description": "The ID of the variant.",
- "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/variants/{variantId}",
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.get"
- },
- "merge": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/variants:merge",
- "path": "v1/variants:merge",
- "id": "genomics.variants.merge",
- "description": "Merges the given variants with existing variants.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach variant will be\nmerged with an existing variant that matches its reference sequence,\nstart, end, reference bases, and alternative bases. If no such variant\nexists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant. Variant info fields are merged as\nspecified in the\ninfoMergeConfig\nfield of the MergeVariantsRequest.\n\nPlease exercise caution when using this method! It is easy to introduce\nmistakes in existing variants and difficult to back out of them. For\nexample,\nsuppose you were trying to merge a new variant with an existing one and\nboth\nvariants contain calls that belong to callsets with the same callset ID.\n\n // Existing variant - irrelevant fields trimmed for clarity\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 0,\n 1\n ],\n }\n ]\n }\n\n // New variant with conflicting call information\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThe resulting merged variant would overwrite the existing calls with those\nfrom the new variant:\n\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThis may be the desired outcome, but it is up to the user to determine if\nif that is indeed the case.",
- "request": {
- "$ref": "MergeVariantsRequest"
- }
- },
- "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": {},
- "flatPath": "v1/variants:import",
- "path": "v1/variants:import",
- "id": "genomics.variants.import"
- },
- "delete": {
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.delete",
- "description": "Deletes a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "variantId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "variantId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the variant to be deleted."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variants/{variantId}"
- }
- }
- },
- "annotationsets": {
- "methods": {
- "search": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchAnnotationSetsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/annotationsets/search",
- "id": "genomics.annotationsets.search",
- "path": "v1/annotationsets/search",
- "description": "Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets.",
- "request": {
- "$ref": "SearchAnnotationSetsRequest"
- }
- },
- "get": {
- "description": "Gets an annotation set. Caller must have READ permission for\nthe associated dataset.",
- "httpMethod": "GET",
- "parameterOrder": [
- "annotationSetId"
- ],
- "response": {
- "$ref": "AnnotationSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "annotationSetId": {
- "location": "path",
- "description": "The ID of the annotation set to be retrieved.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.get",
- "path": "v1/annotationsets/{annotationSetId}"
- },
- "update": {
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.update",
- "path": "v1/annotationsets/{annotationSetId}",
- "description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset.",
- "request": {
- "$ref": "AnnotationSet"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "annotationSetId"
- ],
- "response": {
- "$ref": "AnnotationSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "type": "string",
- "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"
- },
- "annotationSetId": {
- "description": "The ID of the annotation set to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnnotationSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/annotationsets",
- "id": "genomics.annotationsets.create",
- "path": "v1/annotationsets",
- "description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field).",
- "request": {
- "$ref": "AnnotationSet"
- }
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "annotationSetId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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}",
- "id": "genomics.annotationsets.delete",
- "path": "v1/annotationsets/{annotationSetId}",
- "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set."
- }
- }
- },
"references": {
"resources": {
"bases": {
"methods": {
"list": {
- "response": {
- "$ref": "ListBasesResponse"
- },
+ "flatPath": "v1/references/{referenceId}/bases",
+ "id": "genomics.references.bases.list",
+ "path": "v1/references/{referenceId}/bases",
+ "description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).",
+ "httpMethod": "GET",
"parameterOrder": [
"referenceId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBasesResponse"
+ },
"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.",
@@ -1181,70 +38,58 @@
"type": "string"
},
"referenceId": {
- "location": "path",
"description": "The ID of the reference.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"end": {
- "location": "query",
"description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
"format": "int64",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageToken": {
"location": "query",
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
- },
- "pageSize": {
- "type": "integer",
- "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"
}
},
"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)."
+ ]
}
}
}
},
"methods": {
"search": {
- "flatPath": "v1/references/search",
"path": "v1/references/search",
"id": "genomics.references.search",
- "description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).",
"request": {
"$ref": "SearchReferencesRequest"
},
+ "description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).",
"response": {
"$ref": "SearchReferencesResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
- "parameters": {}
+ "flatPath": "v1/references/search"
},
"get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Reference"
- },
- "parameterOrder": [
- "referenceId"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {
"referenceId": {
@@ -1254,111 +99,23 @@
"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}",
"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)."
+ "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"
+ }
}
}
},
"datasets": {
"methods": {
- "delete": {
- "flatPath": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.delete",
- "path": "v1/datasets/{datasetId}",
- "description": "Deletes a dataset and all of its contents (all read group sets,\nreference sets, variant sets, call sets, annotation sets, etc.)\nThis is reversible (up to one week after the deletion) via\nthe\ndatasets.undelete\noperation.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "datasetId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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 deleted.",
- "required": true,
- "type": "string"
- }
- }
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListDatasetsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "Required. The Google Cloud project ID to list datasets for.",
- "type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/datasets",
- "id": "genomics.datasets.list",
- "path": "v1/datasets",
- "description": "Lists datasets within a project.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "setIamPolicy": {
- "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.",
- "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"
- },
"create": {
- "id": "genomics.datasets.create",
- "path": "v1/datasets",
"description": "Creates a new dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"request": {
"$ref": "Dataset"
@@ -1373,7 +130,38 @@
"https://www.googleapis.com/auth/genomics"
],
"parameters": {},
- "flatPath": "v1/datasets"
+ "flatPath": "v1/datasets",
+ "id": "genomics.datasets.create",
+ "path": "v1/datasets"
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^datasets/[^/]+$"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "genomics.datasets.setIamPolicy"
},
"getIamPolicy": {
"httpMethod": "POST",
@@ -1405,13 +193,17 @@
}
},
"undelete": {
- "httpMethod": "POST",
- "parameterOrder": [
- "datasetId"
- ],
+ "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",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
@@ -1425,61 +217,23 @@
}
},
"flatPath": "v1/datasets/{datasetId}:undelete",
- "id": "genomics.datasets.undelete",
"path": "v1/datasets/{datasetId}:undelete",
- "description": "Undeletes a dataset by restoring a dataset which was deleted via this API.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible for a week after the deletion occurred.",
- "request": {
- "$ref": "UndeleteDatasetRequest"
- }
- },
- "patch": {
- "id": "genomics.datasets.patch",
- "path": "v1/datasets/{datasetId}",
- "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "Dataset"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "datasetId"
- ],
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "datasetId": {
- "description": "The ID of the dataset to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/datasets/{datasetId}"
+ "id": "genomics.datasets.undelete"
},
"get": {
"httpMethod": "GET",
- "response": {
- "$ref": "Dataset"
- },
"parameterOrder": [
"datasetId"
],
+ "response": {
+ "$ref": "Dataset"
+ },
"parameters": {
"datasetId": {
+ "location": "path",
"description": "The ID of the dataset.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -1492,19 +246,422 @@
"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)"
},
- "testIamPermissions": {
- "httpMethod": "POST",
+ "patch": {
+ "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
+ "request": {
+ "$ref": "Dataset"
+ },
+ "response": {
+ "$ref": "Dataset"
+ },
"parameterOrder": [
- "resource"
+ "datasetId"
],
+ "httpMethod": "PATCH",
+ "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}",
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.patch"
+ },
+ "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": {
+ "required": true,
+ "type": "string",
"pattern": "^datasets/[^/]+$",
"location": "path",
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "genomics.datasets.testIamPermissions"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "httpMethod": "DELETE",
+ "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 deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}",
+ "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)"
+ },
+ "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)",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListDatasetsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response."
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/datasets",
+ "id": "genomics.datasets.list",
+ "path": "v1/datasets"
+ }
+ }
+ },
+ "annotations": {
+ "methods": {
+ "update": {
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "updateMask": {
+ "type": "string",
+ "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"
+ },
+ "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}",
+ "path": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.update",
+ "request": {
+ "$ref": "Annotation"
+ },
+ "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset."
+ },
+ "delete": {
+ "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "annotationId": {
+ "description": "The ID of the annotation to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/annotations/{annotationId}",
+ "path": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.delete"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotations",
+ "id": "genomics.annotations.create",
+ "path": "v1/annotations",
+ "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."
+ },
+ "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": {
+ "flatPath": "v1/annotations/search",
+ "path": "v1/annotations/search",
+ "id": "genomics.annotations.search",
+ "request": {
+ "$ref": "SearchAnnotationsRequest"
+ },
+ "description": "Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets.",
+ "response": {
+ "$ref": "SearchAnnotationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ]
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "response": {
+ "$ref": "Annotation"
+ },
+ "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}",
+ "id": "genomics.annotations.get",
+ "path": "v1/annotations/{annotationId}",
+ "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set."
+ }
+ }
+ },
+ "variantsets": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.delete",
+ "path": "v1/variantsets/{variantSetId}",
+ "description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "variantSetId": {
+ "description": "The ID of the variant set to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variantsets",
+ "id": "genomics.variantsets.create",
+ "path": "v1/variantsets"
+ },
+ "export": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "variantSetId": {
+ "location": "path",
+ "description": "Required. The ID of the variant set that contains variant data which\nshould be exported. The caller must have READ access to this variant set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variantsets/{variantSetId}:export",
+ "path": "v1/variantsets/{variantSetId}:export",
+ "id": "genomics.variantsets.export",
+ "request": {
+ "$ref": "ExportVariantSetRequest"
+ },
+ "description": "Exports variant set data to an external destination.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "search": {
+ "id": "genomics.variantsets.search",
+ "path": "v1/variantsets/search",
+ "description": "Returns a list of all variant sets matching search criteria.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).",
+ "request": {
+ "$ref": "SearchVariantSetsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchVariantSetsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variantsets/search"
+ },
+ "get": {
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.get",
+ "description": "Gets a variant set by ID.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "GET",
+ "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}"
+ },
+ "patch": {
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.patch",
+ "request": {
+ "$ref": "VariantSet"
+ },
+ "description": "Updates a variant set using patch semantics.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "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"
}
@@ -1513,18 +670,899 @@
"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",
+ "flatPath": "v1/variantsets/{variantSetId}"
+ }
+ }
+ },
+ "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. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
"request": {
- "$ref": "TestIamPermissionsRequest"
+ "$ref": "CancelOperationRequest"
},
- "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": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled."
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "genomics.operations.cancel"
+ },
+ "list": {
+ "path": "v1/{+name}",
+ "id": "genomics.operations.list",
+ "description": "Lists operations that match the specified filter in the request.",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations$"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list page token."
+ },
+ "pageSize": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/operations"
+ },
+ "get": {
+ "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": "v1/operations/{operationsId}",
+ "id": "genomics.operations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ }
+ }
+ },
+ "referencesets": {
+ "methods": {
+ "search": {
+ "response": {
+ "$ref": "SearchReferenceSetsResponse"
+ },
+ "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/referencesets/search",
+ "path": "v1/referencesets/search",
+ "id": "genomics.referencesets.search",
+ "request": {
+ "$ref": "SearchReferenceSetsRequest"
+ },
+ "description": "Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)"
+ },
+ "get": {
+ "description": "Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "referenceSetId"
+ ],
+ "response": {
+ "$ref": "ReferenceSet"
+ },
+ "parameters": {
+ "referenceSetId": {
+ "location": "path",
+ "description": "The ID of the reference set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/referencesets/{referenceSetId}",
+ "id": "genomics.referencesets.get",
+ "path": "v1/referencesets/{referenceSetId}"
+ }
+ }
+ },
+ "readgroupsets": {
+ "methods": {
+ "export": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "readGroupSetId": {
+ "location": "path",
+ "description": "Required. The ID of the read group set to export. The caller must have\nREAD access to this read group set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}:export",
+ "path": "v1/readgroupsets/{readGroupSetId}:export",
+ "id": "genomics.readgroupsets.export",
+ "request": {
+ "$ref": "ExportReadGroupSetRequest"
+ },
+ "description": "Exports a read group set to a BAM file in Google Cloud Storage.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nNote that currently there may be some differences between exported BAM\nfiles and the original BAM file at the time of import. See\nImportReadGroupSets\nfor caveats."
+ },
+ "search": {
+ "request": {
+ "$ref": "SearchReadGroupSetsRequest"
+ },
+ "description": "Searches for read group sets matching the criteria.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).",
+ "response": {
+ "$ref": "SearchReadGroupSetsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/readgroupsets/search",
+ "path": "v1/readgroupsets/search",
+ "id": "genomics.readgroupsets.search"
+ },
+ "patch": {
+ "response": {
+ "$ref": "ReadGroupSet"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "readGroupSetId": {
+ "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
+ "path": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.patch",
+ "request": {
+ "$ref": "ReadGroupSet"
+ },
+ "description": "Updates a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ReadGroupSet"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "parameters": {
+ "readGroupSetId": {
+ "description": "The ID of the read group set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.get",
+ "path": "v1/readgroupsets/{readGroupSetId}",
+ "description": "Gets a read group set by ID.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "import": {
+ "request": {
+ "$ref": "ImportReadGroupSetsRequest"
+ },
+ "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/readgroupsets:import",
+ "id": "genomics.readgroupsets.import",
+ "path": "v1/readgroupsets:import"
+ },
+ "delete": {
+ "description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "parameters": {
+ "readGroupSetId": {
+ "location": "path",
+ "description": "The ID of the read group set to be deleted. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.delete",
+ "path": "v1/readgroupsets/{readGroupSetId}"
+ }
+ },
+ "resources": {
+ "coveragebuckets": {
+ "methods": {
+ "list": {
+ "description": "Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset.",
+ "response": {
+ "$ref": "ListCoverageBucketsResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "parameters": {
+ "end": {
+ "location": "query",
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "readGroupSetId": {
+ "description": "Required. The ID of the read group set over which coverage is requested.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "referenceName": {
+ "location": "query",
+ "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
+ "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
+ "id": "genomics.readgroupsets.coveragebuckets.list"
+ }
+ }
+ }
+ }
+ },
+ "reads": {
+ "methods": {
+ "search": {
+ "flatPath": "v1/reads/search",
+ "path": "v1/reads/search",
+ "id": "genomics.reads.search",
+ "request": {
+ "$ref": "SearchReadsRequest"
+ },
+ "description": "Gets a list of reads for one or more read group sets.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nReads search operates over a genomic coordinate space of reference sequence\n& position defined over the reference sequences to which the requested\nread group sets are aligned.\n\nIf a target positional range is specified, search returns all reads whose\nalignment to the reference genome overlap the range. A query which\nspecifies only read group set IDs yields all reads in those read group\nsets, including unmapped reads.\n\nAll reads returned (including reads on subsequent pages) are ordered by\ngenomic coordinate (by reference sequence, then position). Reads with\nequivalent genomic coordinates are returned in an unspecified order. This\norder is consistent, such that two queries for the same content (regardless\nof page size) yield reads in the same order across their respective streams\nof paginated responses.\n\nImplements\n[GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).",
+ "response": {
+ "$ref": "SearchReadsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ]
+ }
+ }
+ },
+ "callsets": {
+ "methods": {
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "CallSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/callsets",
+ "id": "genomics.callsets.create",
+ "path": "v1/callsets"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "parameters": {
+ "callSetId": {
+ "description": "The ID of the call set to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/callsets/{callSetId}",
+ "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"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/callsets/search",
+ "id": "genomics.callsets.search",
+ "path": "v1/callsets/search",
+ "request": {
+ "$ref": "SearchCallSetsRequest"
+ },
+ "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)."
+ },
+ "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": {
+ "location": "query",
+ "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "callSetId": {
+ "description": "The ID of the call set to be updated.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/callsets/{callSetId}"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "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}",
+ "id": "genomics.callsets.get",
+ "path": "v1/callsets/{callSetId}",
+ "description": "Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ }
+ }
+ },
+ "annotationsets": {
+ "methods": {
+ "get": {
+ "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}",
+ "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"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "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": {
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotationsets",
+ "path": "v1/annotationsets",
+ "id": "genomics.annotationsets.create",
+ "request": {
+ "$ref": "AnnotationSet"
+ },
+ "description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field)."
+ },
+ "delete": {
+ "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",
+ "parameters": {
+ "annotationSetId": {
+ "description": "The ID of the annotation set to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotationsets/{annotationSetId}"
+ },
+ "search": {
+ "flatPath": "v1/annotationsets/search",
+ "id": "genomics.annotationsets.search",
+ "path": "v1/annotationsets/search",
+ "request": {
+ "$ref": "SearchAnnotationSetsRequest"
+ },
+ "description": "Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets.",
+ "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"
+ ]
+ }
+ }
+ },
+ "variants": {
+ "methods": {
+ "import": {
+ "flatPath": "v1/variants:import",
+ "id": "genomics.variants.import",
+ "path": "v1/variants:import",
+ "description": "Creates variant data by asynchronously importing the provided information.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe variants for import will be merged with any existing variant that\nmatches its reference sequence, start, end, reference bases, and\nalternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant, and Variant info fields are merged\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF files, QUAL and FILTER fields will\nbe moved to the call level; these are sometimes interpreted in a\ncall-specific context.\nImported VCF headers are appended to the metadata already in a variant set.",
+ "request": {
+ "$ref": "ImportVariantsRequest"
+ },
+ "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": {}
+ },
+ "delete": {
+ "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)",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "variantId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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"
+ }
+ }
+ },
+ "merge": {
+ "id": "genomics.variants.merge",
+ "path": "v1/variants:merge",
+ "request": {
+ "$ref": "MergeVariantsRequest"
+ },
+ "description": "Merges the given variants with existing variants.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach variant will be\nmerged with an existing variant that matches its reference sequence,\nstart, end, reference bases, and alternative bases. If no such variant\nexists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant. Variant info fields are merged as\nspecified in the\ninfoMergeConfig\nfield of the MergeVariantsRequest.\n\nPlease exercise caution when using this method! It is easy to introduce\nmistakes in existing variants and difficult to back out of them. For\nexample,\nsuppose you were trying to merge a new variant with an existing one and\nboth\nvariants contain calls that belong to callsets with the same callset ID.\n\n // Existing variant - irrelevant fields trimmed for clarity\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 0,\n 1\n ],\n }\n ]\n }\n\n // New variant with conflicting call information\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThe resulting merged variant would overwrite the existing calls with those\nfrom the new variant:\n\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThis may be the desired outcome, but it is up to the user to determine if\nif that is indeed the case.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variants:merge"
+ },
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Variant"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variants",
+ "id": "genomics.variants.create",
+ "path": "v1/variants"
+ },
+ "search": {
+ "path": "v1/variants/search",
+ "id": "genomics.variants.search",
+ "description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).",
+ "request": {
+ "$ref": "SearchVariantsRequest"
+ },
+ "response": {
+ "$ref": "SearchVariantsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variants/search"
+ },
+ "patch": {
+ "request": {
+ "$ref": "Variant"
+ },
+ "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "variantId"
+ ],
+ "response": {
+ "$ref": "Variant"
+ },
+ "parameters": {
+ "variantId": {
+ "location": "path",
+ "description": "The ID of the variant to be updated.",
+ "required": true,
+ "type": "string"
+ },
+ "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}"
+ },
+ "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"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "variantId": {
+ "location": "path",
+ "description": "The ID of the variant.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/variants/{variantId}",
+ "id": "genomics.variants.get",
+ "path": "v1/variants/{variantId}"
}
}
}
},
"parameters": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "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.",
@@ -1545,75 +1583,79 @@
"type": "boolean",
"default": "true",
"location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "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": {
- "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"
}
},
"schemas": {
+ "Program": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The display name of the program. This is typically the colloquial name of\nthe tool used, for example 'bwa' or 'picard'.",
+ "type": "string"
+ },
+ "commandLine": {
+ "description": "The command line used to run this program.",
+ "type": "string"
+ },
+ "prevProgramId": {
+ "description": "The ID of the program run before this one.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The user specified locally unique ID of the program. Used along with\n`prevProgramId` to define an ordering between programs.",
+ "type": "string"
+ },
+ "version": {
+ "type": "string",
+ "description": "The version of the program run."
+ }
+ },
+ "id": "Program"
+ },
+ "CoverageBucket": {
+ "description": "A bucket over which read coverage has been precomputed. A bucket corresponds\nto a specific range of the reference sequence.",
+ "type": "object",
+ "properties": {
+ "meanCoverage": {
+ "description": "The average number of reads which are aligned to each individual\nreference base in this bucket.",
+ "format": "float",
+ "type": "number"
+ },
+ "range": {
+ "description": "The genomic coordinate range spanned by this bucket.",
+ "$ref": "Range"
+ }
+ },
+ "id": "CoverageBucket"
+ },
+ "ComputeEngine": {
+ "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
+ "type": "object",
+ "properties": {
+ "machineType": {
+ "description": "The machine type of the instance.",
+ "type": "string"
+ },
+ "diskNames": {
+ "description": "The names of the disks that were created for this pipeline.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "instanceName": {
+ "type": "string",
+ "description": "The instance on which the operation is running."
+ },
+ "zone": {
+ "description": "The availability zone in which the instance resides.",
+ "type": "string"
+ }
+ },
+ "id": "ComputeEngine"
+ },
"ExternalId": {
+ "id": "ExternalId",
"type": "object",
"properties": {
"sourceName": {
@@ -1621,15 +1663,19 @@
"type": "string"
},
"id": {
- "description": "The id used by the source of this data.",
- "type": "string"
+ "type": "string",
+ "description": "The id used by the source of this data."
}
- },
- "id": "ExternalId"
+ }
},
"SearchVariantSetsRequest": {
"type": "object",
"properties": {
+ "pageSize": {
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
+ "format": "int32",
+ "type": "integer"
+ },
"datasetIds": {
"description": "Exactly one dataset ID must be provided here. Only variant sets which\nbelong to this dataset will be returned.",
"type": "array",
@@ -1640,31 +1686,30 @@
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
- },
- "pageSize": {
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
- "format": "int32",
- "type": "integer"
}
},
"id": "SearchVariantSetsRequest",
"description": "The search variant sets request."
},
"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": {
+ "description": {
+ "description": "A textual description of this metadata.",
+ "type": "string"
+ },
"info": {
- "description": "Remaining structured metadata key-value pairs. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "any"
}
- }
+ },
+ "description": "Remaining structured metadata key-value pairs. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values)."
},
"type": {
- "description": "The type of data. Possible types include: Integer, Float,\nFlag, Character, and String.",
"type": "string",
"enumDescriptions": [
"",
@@ -1681,43 +1726,48 @@
"FLAG",
"CHARACTER",
"STRING"
- ]
+ ],
+ "description": "The type of data. Possible types include: Integer, Float,\nFlag, Character, and String."
},
- "value": {
- "description": "The value field for simple metadata",
+ "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"
},
- "number": {
- "description": "The number of values that can be included in a field described by this\nmetadata.",
- "type": "string"
+ "value": {
+ "type": "string",
+ "description": "The value field for simple metadata"
},
"key": {
"description": "The top-level key.",
"type": "string"
- },
- "description": {
- "description": "A textual description of this metadata.",
- "type": "string"
}
},
- "id": "VariantSetMetadata",
- "description": "Metadata describes a single piece of variant call metadata.\nThese data include a top level key and either a single value string (value)\nor a list of key-value pairs (info.)\nValue and info are mutually exclusive."
+ "id": "VariantSetMetadata"
},
"Reference": {
+ "description": "A reference is a canonical assembled DNA sequence, intended to act as a\nreference coordinate space for other genomic annotations. A single reference\nmight represent the human chromosome 1 or mitochandrial DNA, for instance. A\nreference belongs to one or more reference sets.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
"properties": {
- "sourceUri": {
- "type": "string",
- "description": "The URI from which the sequence was obtained. Typically specifies a FASTA\nformat file."
+ "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"
@@ -1734,35 +1784,19 @@
"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"
- }
}
},
- "id": "Reference",
- "description": "A reference is a canonical assembled DNA sequence, intended to act as a\nreference coordinate space for other genomic annotations. A single reference\nmight represent the human chromosome 1 or mitochandrial DNA, for instance. A\nreference belongs to one or more reference sets.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object"
+ "id": "Reference"
},
"SearchReferenceSetsRequest": {
"type": "object",
"properties": {
- "md5checksums": {
- "description": "If present, return reference sets for which the\nmd5checksum matches exactly.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"accessions": {
- "description": "If present, return reference sets for which a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numbers typically have a main number\nand a version, for example `NC_000001.11`.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "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`."
},
"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.",
@@ -1774,13 +1808,21 @@
"type": "integer"
},
"assemblyId": {
- "type": "string",
- "description": "If present, return reference sets for which a substring of their\n`assemblyId` matches this string (case insensitive)."
+ "description": "If present, return reference sets for which a substring of their\n`assemblyId` matches this string (case insensitive).",
+ "type": "string"
+ },
+ "md5checksums": {
+ "description": "If present, return reference sets for which the\nmd5checksum matches exactly.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "SearchReferenceSetsRequest"
},
"SetIamPolicyRequest": {
+ "id": "SetIamPolicyRequest",
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
@@ -1788,11 +1830,9 @@
"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"
+ }
},
"MergeVariantsRequest": {
- "type": "object",
"properties": {
"variants": {
"description": "The variants to be merged with existing variants.",
@@ -1802,7 +1842,6 @@
}
},
"infoMergeConfig": {
- "type": "object",
"additionalProperties": {
"enum": [
"INFO_MERGE_OPERATION_UNSPECIFIED",
@@ -1811,40 +1850,21 @@
],
"type": "string"
},
- "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them."
+ "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them.",
+ "type": "object"
},
"variantSetId": {
"description": "The destination variant set.",
"type": "string"
}
},
- "id": "MergeVariantsRequest"
- },
- "BatchCreateAnnotationsRequest": {
- "id": "BatchCreateAnnotationsRequest",
- "type": "object",
- "properties": {
- "annotations": {
- "type": "array",
- "items": {
- "$ref": "Annotation"
- },
- "description": "The annotations to be created. At most 4096 can be specified in a single\nrequest."
- },
- "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": "MergeVariantsRequest",
+ "type": "object"
},
"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": {
- "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"
@@ -1854,40 +1874,40 @@
"type": "boolean"
},
"readNumber": {
+ "type": "integer",
"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": {
- "type": "string",
- "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)."
+ "format": "int32"
},
"alignedSequence": {
"description": "The bases of the read sequence contained in this alignment record,\n**without CIGAR operations applied** (equivalent to SEQ in SAM).\n`alignedSequence` and `alignedQuality` may be\nshorter than the full read sequence and quality. This will occur if the\nalignment is part of a chimeric alignment, or if the read was trimmed. When\nthis occurs, the CIGAR for this read will begin/end with a hard clip\noperator that will indicate the length of the excised sequence.",
"type": "string"
},
- "nextMatePosition": {
- "$ref": "Position",
- "description": "The mapping of the primary alignment of the\n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position and mate strand in SAM."
+ "readGroupId": {
+ "description": "The ID of the read group this read belongs to. A read belongs to exactly\none read group. This is a server-generated ID which is distinct from SAM's\nRG tag (for that value, see\nReadGroup.name).",
+ "type": "string"
},
"info": {
- "type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "any"
}
},
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values)."
+ "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"
+ "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"
},
+ "properPlacement": {
+ "description": "The orientation and the distance between reads from the fragment are\nconsistent with the sequencing protocol (SAM flag 0x2).",
+ "type": "boolean"
+ },
"fragmentLength": {
"description": "The observed length of the fragment, equivalent to TLEN in SAM.",
"format": "int32",
@@ -1898,78 +1918,53 @@
"type": "boolean"
},
"alignedQuality": {
+ "description": "The quality of the read sequence contained in this alignment record\n(equivalent to QUAL in SAM).\n`alignedSequence` and `alignedQuality` may be shorter than the full read\nsequence and quality. This will occur if the alignment is part of a\nchimeric alignment, or if the read was trimmed. When this occurs, the CIGAR\nfor this read will begin/end with a hard clip operator that will indicate\nthe length of the excised sequence.",
"type": "array",
"items": {
- "type": "integer",
- "format": "int32"
- },
- "description": "The quality of the read sequence contained in this alignment record\n(equivalent to QUAL in SAM).\n`alignedSequence` and `alignedQuality` may be shorter than the full read\nsequence and quality. This will occur if the alignment is part of a\nchimeric alignment, or if the read was trimmed. When this occurs, the CIGAR\nfor this read will begin/end with a hard clip operator that will indicate\nthe length of the excised sequence."
+ "format": "int32",
+ "type": "integer"
+ }
},
"alignment": {
- "$ref": "LinearAlignment",
- "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads."
- },
- "id": {
- "description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.",
- "type": "string"
+ "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads.",
+ "$ref": "LinearAlignment"
},
"numberReads": {
"description": "The number of reads in the fragment (extension to SAM flag 0x1).",
"format": "int32",
"type": "integer"
},
+ "id": {
+ "description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.",
+ "type": "string"
+ },
"secondaryAlignment": {
- "type": "boolean",
- "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."
+ "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"
}
},
"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)",
+ "BatchCreateAnnotationsRequest": {
+ "id": "BatchCreateAnnotationsRequest",
"type": "object",
"properties": {
- "sourceAccessions": {
- "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`.",
+ "annotations": {
+ "description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
"type": "array",
"items": {
- "type": "string"
+ "$ref": "Annotation"
}
},
- "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.",
- "format": "int32",
- "type": "integer"
- },
- "referenceIds": {
- "description": "The IDs of the reference objects that are part of this set.\n`Reference.md5checksum` must be unique within this set.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "md5checksum": {
- "description": "Order-independent MD5 checksum which identifies this reference set. The\nchecksum is computed by sorting all lower case hexidecimal string\n`reference.md5checksum` (for all reference in this set) in\nascending lexicographic order, concatenating, and taking the MD5 of that\nvalue. The resulting value is represented in lower case hexadecimal format.",
- "type": "string"
- },
- "assemblyId": {
- "description": "Public id of this reference set, such as `GRCh37`.",
- "type": "string"
- },
- "id": {
- "description": "The server-generated reference set ID, unique across all reference sets.",
+ "requestId": {
+ "description": "A unique request ID which enables the server to detect duplicated requests.\nIf provided, duplicated requests will result in the same response; if not\nprovided, duplicated requests may result in duplicated data. For a given\nannotation set, callers should not reuse `request_id`s when writing\ndifferent batches of annotations - behavior in this case is undefined.\nA common approach is to use a UUID. For batch jobs where worker crashes are\na possibility, consider using some unique variant of a worker or run ID.",
"type": "string"
}
- },
- "id": "ReferenceSet"
+ }
},
"CigarUnit": {
"description": "A single CIGAR operation.",
@@ -1980,12 +1975,11 @@
"type": "string"
},
"operationLength": {
+ "type": "string",
"description": "The number of genomic bases that the operation runs for. Required.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
},
"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`.",
@@ -2009,18 +2003,87 @@
"PAD",
"SEQUENCE_MATCH",
"SEQUENCE_MISMATCH"
- ]
+ ],
+ "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": {
+ "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": {
+ "type": "string",
+ "description": "Free text description of this reference set."
+ },
+ "ncbiTaxonId": {
+ "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)\nindicating the species which this reference set is intended to model. Note\nthat contained references may specify a different `ncbiTaxonId`, as\nassemblies may contain reference sequences which do not belong to the\nmodeled species, for example EBV in a human reference genome.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceUri": {
+ "description": "The URI from which the references were obtained.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "md5checksum": {
+ "description": "Order-independent MD5 checksum which identifies this reference set. The\nchecksum is computed by sorting all lower case hexidecimal string\n`reference.md5checksum` (for all reference in this set) in\nascending lexicographic order, concatenating, and taking the MD5 of that\nvalue. The resulting value is represented in lower case hexadecimal format.",
+ "type": "string"
+ },
+ "assemblyId": {
+ "description": "Public id of this reference set, such as `GRCh37`.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated reference set ID, unique across all reference sets.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "codingSequence": {
+ "$ref": "CodingSequence",
+ "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA."
+ },
+ "geneId": {
+ "description": "The annotation ID of the gene from which this transcript is transcribed.",
+ "type": "string"
+ },
+ "exons": {
+ "description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
+ "type": "array",
+ "items": {
+ "$ref": "Exon"
+ }
+ }
+ },
+ "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": {
"datasetId": {
- "description": "The dataset to which this annotation set belongs.",
- "type": "string"
+ "type": "string",
+ "description": "The dataset to which this annotation set belongs."
},
"sourceUri": {
"description": "The source URI describing the file from which this annotation set was\ngenerated, if any.",
@@ -2035,6 +2098,7 @@
"type": "string"
},
"type": {
+ "description": "The type of annotations contained within this set.",
"type": "string",
"enumDescriptions": [
"",
@@ -2049,8 +2113,7 @@
"VARIANT",
"GENE",
"TRANSCRIPT"
- ],
- "description": "The type of annotations contained within this set."
+ ]
},
"info": {
"additionalProperties": {
@@ -2069,28 +2132,6 @@
},
"id": "AnnotationSet"
},
- "Transcript": {
- "description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
- "type": "object",
- "properties": {
- "geneId": {
- "description": "The annotation ID of the gene from which this transcript is transcribed.",
- "type": "string"
- },
- "exons": {
- "description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
- "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"
- }
- },
- "id": "Transcript"
- },
"Experiment": {
"type": "object",
"properties": {
@@ -2114,7 +2155,6 @@
"id": "Experiment"
},
"ListDatasetsResponse": {
- "description": "The dataset list response.",
"type": "object",
"properties": {
"datasets": {
@@ -2129,7 +2169,8 @@
"type": "string"
}
},
- "id": "ListDatasetsResponse"
+ "id": "ListDatasetsResponse",
+ "description": "The dataset list response."
},
"TestIamPermissionsRequest": {
"properties": {
@@ -2145,27 +2186,6 @@
"description": "Request message for `TestIamPermissions` method.",
"type": "object"
},
- "Exon": {
- "type": "object",
- "properties": {
- "start": {
- "description": "The start position of the exon on this annotation's reference sequence,\n0-based inclusive. Note that this is relative to the reference start, and\n**not** the containing annotation start.",
- "format": "int64",
- "type": "string"
- },
- "end": {
- "type": "string",
- "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"
- },
- "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"
- }
- },
- "id": "Exon"
- },
"ExportReadGroupSetRequest": {
"description": "The read group set export request.",
"type": "object",
@@ -2188,8 +2208,28 @@
},
"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)",
"type": "object",
"properties": {
"name": {
@@ -2197,14 +2237,14 @@
"type": "string"
},
"info": {
+ "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"
+ "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)."
},
"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).",
@@ -2223,33 +2263,58 @@
"type": "string"
},
"sampleId": {
- "description": "The sample ID this call set corresponds to.",
- "type": "string"
+ "type": "string",
+ "description": "The sample ID this call set corresponds to."
}
},
- "id": "CallSet"
+ "id": "CallSet",
+ "description": "A call set is a collection of variant calls, typically for one sample. It\nbelongs to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
"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"
- }
+ },
+ "description": "The matching annotation sets."
}
},
- "id": "SearchAnnotationSetsResponse"
+ "id": "SearchAnnotationSetsResponse",
+ "type": "object"
},
"ImportVariantsRequest": {
+ "id": "ImportVariantsRequest",
"description": "The variant data import request.",
"type": "object",
"properties": {
+ "infoMergeConfig": {
+ "additionalProperties": {
+ "type": "string",
+ "enum": [
+ "INFO_MERGE_OPERATION_UNSPECIFIED",
+ "IGNORE_NEW",
+ "MOVE_TO_CALLS"
+ ]
+ },
+ "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
+ "type": "object"
+ },
+ "variantSetId": {
+ "description": "Required. The variant set to which variant data should be imported.",
+ "type": "string"
+ },
+ "sourceUris": {
+ "description": "A list of URIs referencing variant files in Google Cloud Storage. URIs can\ninclude wildcards [as described\nhere](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).\nNote that recursive wildcards ('**') are not supported.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"normalizeReferenceNames": {
"description": "Convert reference names to the canonical representation.\nhg19 haploytypes (those reference names containing \"_hap\")\nare not modified in any way.\nAll other reference names are modified according to the following rules:\nThe reference name is capitalized.\nThe \"chr\" prefix is dropped for all autosomes and sex chromsomes.\nFor example \"chr17\" becomes \"17\" and \"chrX\" becomes \"X\".\nAll mitochondrial chromosomes (\"chrM\", \"chrMT\", etc) become \"MT\".",
"type": "boolean"
@@ -2267,99 +2332,35 @@
],
"description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.",
"type": "string"
- },
- "infoMergeConfig": {
- "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
- "type": "object",
- "additionalProperties": {
- "enum": [
- "INFO_MERGE_OPERATION_UNSPECIFIED",
- "IGNORE_NEW",
- "MOVE_TO_CALLS"
- ],
- "type": "string"
- }
- },
- "variantSetId": {
- "description": "Required. The variant set to which variant data should be imported.",
+ }
+ }
+ },
+ "ListCoverageBucketsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
- "sourceUris": {
- "description": "A list of URIs referencing variant files in Google Cloud Storage. URIs can\ninclude wildcards [as described\nhere](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).\nNote that recursive wildcards ('**') are not supported.",
+ "bucketWidth": {
+ "type": "string",
+ "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"
+ },
+ "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": {
- "type": "string"
+ "$ref": "CoverageBucket"
}
}
},
- "id": "ImportVariantsRequest"
+ "id": "ListCoverageBucketsResponse"
},
"VariantAnnotation": {
"type": "object",
"properties": {
- "alternateBases": {
- "description": "The alternate allele for this variant. If multiple alternate alleles\nexist at this location, create a separate variant for each one, as they\nmay represent distinct conditions.",
- "type": "string"
- },
- "geneId": {
- "description": "Google annotation ID of the gene affected by this variant. This should\nbe provided when the variant is created.",
- "type": "string"
- },
- "clinicalSignificance": {
- "enumDescriptions": [
- "",
- "`OTHER` should be used when no other clinical significance\nvalue will suffice.",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "`MULTIPLE_REPORTED` should be used when multiple clinical\nsignficances are reported for a variant. The original clinical\nsignificance values may be provided in the `info` field."
- ],
- "enum": [
- "CLINICAL_SIGNIFICANCE_UNSPECIFIED",
- "CLINICAL_SIGNIFICANCE_OTHER",
- "UNCERTAIN",
- "BENIGN",
- "LIKELY_BENIGN",
- "LIKELY_PATHOGENIC",
- "PATHOGENIC",
- "DRUG_RESPONSE",
- "HISTOCOMPATIBILITY",
- "CONFERS_SENSITIVITY",
- "RISK_FACTOR",
- "ASSOCIATION",
- "PROTECTIVE",
- "MULTIPLE_REPORTED"
- ],
- "description": "Describes the clinical significance of a variant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignificance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/",
- "type": "string"
- },
- "conditions": {
- "description": "The set of conditions associated with this variant.\nA condition describes the way a variant influences human health.",
- "type": "array",
- "items": {
- "$ref": "ClinicalCondition"
- }
- },
"effect": {
- "enumDescriptions": [
- "",
- "`EFFECT_OTHER` should be used when no other Effect\nwill suffice.",
- "`FRAMESHIFT` indicates a mutation in which the insertion or\ndeletion of nucleotides resulted in a frameshift change.",
- "`FRAME_PRESERVING_INDEL` indicates a mutation in which a\nmultiple of three nucleotides has been inserted or deleted, resulting\nin no change to the reading frame of the coding sequence.",
- "`SYNONYMOUS_SNP` indicates a single nucleotide polymorphism\nmutation that results in no amino acid change.",
- "`NONSYNONYMOUS_SNP` indicates a single nucleotide\npolymorphism mutation that results in an amino acid change.",
- "`STOP_GAIN` indicates a mutation that leads to the creation\nof a stop codon at the variant site. Frameshift mutations creating\ndownstream stop codons do not count as `STOP_GAIN`.",
- "`STOP_LOSS` indicates a mutation that eliminates a\nstop codon at the variant site.",
- "`SPLICE_SITE_DISRUPTION` indicates that this variant is\nfound in a splice site for the associated transcript, and alters the\nnormal splicing pattern."
- ],
"enum": [
"EFFECT_UNSPECIFIED",
"EFFECT_OTHER",
@@ -2372,7 +2373,18 @@
"SPLICE_SITE_DISRUPTION"
],
"description": "Effect of the variant on the coding sequence.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "`EFFECT_OTHER` should be used when no other Effect\nwill suffice.",
+ "`FRAMESHIFT` indicates a mutation in which the insertion or\ndeletion of nucleotides resulted in a frameshift change.",
+ "`FRAME_PRESERVING_INDEL` indicates a mutation in which a\nmultiple of three nucleotides has been inserted or deleted, resulting\nin no change to the reading frame of the coding sequence.",
+ "`SYNONYMOUS_SNP` indicates a single nucleotide polymorphism\nmutation that results in no amino acid change.",
+ "`NONSYNONYMOUS_SNP` indicates a single nucleotide\npolymorphism mutation that results in an amino acid change.",
+ "`STOP_GAIN` indicates a mutation that leads to the creation\nof a stop codon at the variant site. Frameshift mutations creating\ndownstream stop codons do not count as `STOP_GAIN`.",
+ "`STOP_LOSS` indicates a mutation that eliminates a\nstop codon at the variant site.",
+ "`SPLICE_SITE_DISRUPTION` indicates that this variant is\nfound in a splice site for the associated transcript, and alters the\nnormal splicing pattern."
+ ]
},
"transcriptIds": {
"description": "Google annotation IDs of the transcripts affected by this variant. These\nshould be provided when the variant is created.",
@@ -2382,6 +2394,7 @@
}
},
"type": {
+ "type": "string",
"enumDescriptions": [
"",
"`TYPE_OTHER` should be used when no other Type will suffice.\nFurther explanation of the variant type may be included in the\ninfo field.",
@@ -2402,41 +2415,67 @@
"STRUCTURAL",
"CNV"
],
- "description": "Type has been adapted from ClinVar's list of variant types.",
+ "description": "Type has been adapted from ClinVar's list of variant types."
+ },
+ "alternateBases": {
+ "type": "string",
+ "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."
+ },
+ "geneId": {
+ "description": "Google annotation ID of the gene affected by this variant. This should\nbe provided when the variant is created.",
"type": "string"
+ },
+ "clinicalSignificance": {
+ "enum": [
+ "CLINICAL_SIGNIFICANCE_UNSPECIFIED",
+ "CLINICAL_SIGNIFICANCE_OTHER",
+ "UNCERTAIN",
+ "BENIGN",
+ "LIKELY_BENIGN",
+ "LIKELY_PATHOGENIC",
+ "PATHOGENIC",
+ "DRUG_RESPONSE",
+ "HISTOCOMPATIBILITY",
+ "CONFERS_SENSITIVITY",
+ "RISK_FACTOR",
+ "ASSOCIATION",
+ "PROTECTIVE",
+ "MULTIPLE_REPORTED"
+ ],
+ "description": "Describes the clinical significance of a variant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignificance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "`OTHER` should be used when no other clinical significance\nvalue will suffice.",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "`MULTIPLE_REPORTED` should be used when multiple clinical\nsignficances are reported for a variant. The original clinical\nsignificance values may be provided in the `info` field."
+ ]
+ },
+ "conditions": {
+ "description": "The set of conditions associated with this variant.\nA condition describes the way a variant influences human health.",
+ "type": "array",
+ "items": {
+ "$ref": "ClinicalCondition"
+ }
}
},
"id": "VariantAnnotation"
},
- "ListCoverageBucketsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results."
- },
- "bucketWidth": {
- "description": "The length of each coverage bucket in base pairs. Note that buckets at the\nend of a reference sequence may be shorter. This value is omitted if the\nbucket width is infinity (the default behaviour, with no range or\n`targetBucketWidth`).",
- "format": "int64",
- "type": "string"
- },
- "coverageBuckets": {
- "type": "array",
- "items": {
- "$ref": "CoverageBucket"
- },
- "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."
- }
- },
- "id": "ListCoverageBucketsResponse"
- },
"ExportVariantSetRequest": {
"description": "The variant data export request.",
"type": "object",
"properties": {
"format": {
- "description": "The format for the exported data.",
- "type": "string",
"enumDescriptions": [
"",
"Export the data to Google BigQuery."
@@ -2444,11 +2483,13 @@
"enum": [
"FORMAT_UNSPECIFIED",
"FORMAT_BIGQUERY"
- ]
+ ],
+ "description": "The format for the exported data.",
+ "type": "string"
},
"bigqueryDataset": {
- "description": "Required. The BigQuery dataset to export data to. This dataset must already\nexist. Note that this is distinct from the Genomics concept of \"dataset\".",
- "type": "string"
+ "type": "string",
+ "description": "Required. The BigQuery dataset to export data to. This dataset must already\nexist. Note that this is distinct from the Genomics concept of \"dataset\"."
},
"bigqueryTable": {
"description": "Required. The BigQuery table to export data to.\nIf the table doesn't exist, it will be created. If it already exists, it\nwill be overwritten.",
@@ -2471,6 +2512,13 @@
"SearchAnnotationsRequest": {
"type": "object",
"properties": {
+ "annotationSetIds": {
+ "description": "Required. The annotation sets to search within. The caller must have\n`READ` access to these annotation sets.\nAll queried annotation sets must have the same type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"referenceName": {
"description": "The name of the reference to query, within the reference set associated\nwith this query.",
"type": "string"
@@ -2494,28 +2542,20 @@
"type": "integer"
},
"start": {
+ "type": "string",
"description": "The start position of the range on the reference, 0-based inclusive. If\nspecified,\nreferenceId or\nreferenceName\nmust be specified. Defaults to 0.",
- "format": "int64",
- "type": "string"
- },
- "annotationSetIds": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Required. The annotation sets to search within. The caller must have\n`READ` access to these annotation sets.\nAll queried annotation sets must have the same type."
+ "format": "int64"
}
},
"id": "SearchAnnotationsRequest"
},
"OperationEvent": {
- "description": "An event that occurred during an Operation.",
"type": "object",
"properties": {
"endTime": {
- "type": "string",
"description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"startTime": {
"description": "Optional time of when event started.",
@@ -2527,7 +2567,8 @@
"type": "string"
}
},
- "id": "OperationEvent"
+ "id": "OperationEvent",
+ "description": "An event that occurred during an Operation."
},
"CodingSequence": {
"type": "object",
@@ -2559,12 +2600,6 @@
},
"id": "TestIamPermissionsResponse"
},
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
"SearchReferencesResponse": {
"type": "object",
"properties": {
@@ -2582,16 +2617,15 @@
},
"id": "SearchReferencesResponse"
},
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
"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"
@@ -2609,6 +2643,13 @@
}
},
"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": {
@@ -2620,70 +2661,40 @@
"TRANSCRIPT"
],
"type": "string"
- },
- "enumDescriptions": [
- "",
- "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
- "A `VARIANT` annotation type.",
- "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
- "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
- ]
+ }
+ },
+ "name": {
+ "description": "Only return annotations sets for which a substring of the name matches this\nstring (case insensitive).",
+ "type": "string"
+ },
+ "referenceSetId": {
+ "description": "If specified, only annotation sets associated with the given reference set\nare returned.",
+ "type": "string"
}
},
- "id": "SearchAnnotationSetsRequest",
- "type": "object"
+ "id": "SearchAnnotationSetsRequest"
},
"SearchReadGroupSetsResponse": {
"properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
"readGroupSets": {
"description": "The list of matching read group sets.",
"type": "array",
"items": {
"$ref": "ReadGroupSet"
}
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
}
},
"id": "SearchReadGroupSetsResponse",
"description": "The read group set search response.",
"type": "object"
},
- "LinearAlignment": {
- "description": "A linear alignment can be represented by one CIGAR string. Describes the\nmapped position and local alignment of the read to the reference.",
- "type": "object",
- "properties": {
- "mappingQuality": {
- "description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
- "format": "int32",
- "type": "integer"
- },
- "position": {
- "$ref": "Position",
- "description": "The position of this alignment."
- },
- "cigar": {
- "description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.",
- "type": "array",
- "items": {
- "$ref": "CigarUnit"
- }
- }
- },
- "id": "LinearAlignment"
- },
"SearchReferencesRequest": {
"type": "object",
"properties": {
- "md5checksums": {
- "description": "If present, return references for which the\nmd5checksum matches exactly.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"accessions": {
"description": "If present, return references for which a prefix of any of\nsourceAccessions match\nany of these strings. Accession numbers typically have a main number and a\nversion, for example `GCF_000001405.26`.",
"type": "array",
@@ -2692,25 +2703,58 @@
}
},
"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",
+ "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."
},
"referenceSetId": {
- "type": "string",
- "description": "If present, return only references which belong to this reference set."
+ "description": "If present, return only references which belong to this reference set.",
+ "type": "string"
},
"pageSize": {
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
"format": "int32",
"type": "integer"
+ },
+ "md5checksums": {
+ "description": "If present, return references for which the\nmd5checksum matches exactly.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "SearchReferencesRequest"
},
- "Dataset": {
- "description": "A Dataset is a collection of genomic data.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "LinearAlignment": {
+ "id": "LinearAlignment",
+ "description": "A linear alignment can be represented by one CIGAR string. Describes the\nmapped position and local alignment of the read to the reference.",
"type": "object",
"properties": {
+ "position": {
+ "description": "The position of this alignment.",
+ "$ref": "Position"
+ },
+ "cigar": {
+ "description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.",
+ "type": "array",
+ "items": {
+ "$ref": "CigarUnit"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "Dataset": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The dataset name.",
+ "type": "string"
+ },
"projectId": {
"description": "The Google Cloud project ID that this dataset belongs to.",
"type": "string"
@@ -2720,16 +2764,13 @@
"type": "string"
},
"createTime": {
+ "type": "string",
"description": "The time this dataset was created, in seconds from the epoch.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "The dataset name.",
- "type": "string"
+ "format": "google-datetime"
}
},
- "id": "Dataset"
+ "id": "Dataset",
+ "description": "A Dataset is a collection of genomic data.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
"ImportVariantsResponse": {
"description": "The variant data import response.",
@@ -2762,8 +2803,8 @@
"type": "string"
},
"referenceSetId": {
- "type": "string",
- "description": "The reference set the reads in this read group are aligned to."
+ "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).",
@@ -2776,8 +2817,13 @@
}
},
"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"
+ "type": "string",
+ "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."
+ },
+ "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": {
"type": "array",
@@ -2786,11 +2832,6 @@
},
"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."
},
- "predictedInsertSize": {
- "type": "integer",
- "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"
- },
"description": {
"description": "A free-form text description of this read group.",
"type": "string"
@@ -2806,17 +2847,6 @@
"description": "A read group set is a logical collection of read groups, which are\ncollections of reads produced by a sequencer. A read group set typically\nmodels reads corresponding to one sample, sequenced one way, and aligned one\nway.\n\n* A read group set belongs to one dataset.\n* A read group belongs to one read group set.\n* A read belongs to one read group.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
- "readGroups": {
- "description": "The read groups in this set. There are typically 1-10 read groups in a read\ngroup set.",
- "type": "array",
- "items": {
- "$ref": "ReadGroup"
- }
- },
- "filename": {
- "description": "The filename of the original source file for this read group set, if any.",
- "type": "string"
- },
"name": {
"description": "The read group set name. By default this will be initialized to the sample\nname of the sequenced data contained in this set.",
"type": "string"
@@ -2842,12 +2872,22 @@
"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"
}
},
"id": "ReadGroupSet"
},
"SearchVariantSetsResponse": {
- "description": "The search variant sets response.",
"type": "object",
"properties": {
"variantSets": {
@@ -2862,7 +2902,8 @@
"type": "string"
}
},
- "id": "SearchVariantSetsResponse"
+ "id": "SearchVariantSetsResponse",
+ "description": "The search variant sets response."
},
"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 `{}`.",
@@ -2874,12 +2915,12 @@
"type": "object",
"properties": {
"status": {
- "description": "The creation status.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The creation status."
},
"annotation": {
- "description": "The created annotation, if creation was successful.",
- "$ref": "Annotation"
+ "$ref": "Annotation",
+ "description": "The created annotation, if creation was successful."
}
},
"id": "Entry"
@@ -2888,24 +2929,23 @@
"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": {
+ "type": "string",
"description": "The 0-based offset from the start of the forward strand for that reference.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
},
"referenceName": {
"description": "The name of the reference in whatever reference set is being used.",
"type": "string"
- },
- "reverseStrand": {
- "description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand.",
- "type": "boolean"
}
},
"id": "Position"
},
"SearchReferenceSetsResponse": {
- "type": "object",
"properties": {
"referenceSets": {
"description": "The matching references sets.",
@@ -2915,11 +2955,12 @@
}
},
"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"
+ "type": "string",
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results."
}
},
- "id": "SearchReferenceSetsResponse"
+ "id": "SearchReferenceSetsResponse",
+ "type": "object"
},
"SearchCallSetsRequest": {
"description": "The call set search request.",
@@ -2949,27 +2990,8 @@
"id": "SearchCallSetsRequest"
},
"ImportReadGroupSetsRequest": {
- "description": "The read group set import request.",
"type": "object",
"properties": {
- "referenceSetId": {
- "description": "The reference set to which the imported read group sets are aligned to, if\nany. The reference names of this reference set must be a superset of those\nfound in the imported file headers. If no reference set id is provided, a\nbest effort is made to associate with a matching reference set.",
- "type": "string"
- },
- "partitionStrategy": {
- "enumDescriptions": [
- "",
- "In most cases, this strategy yields one read group set per file. This is\nthe default behavior.\n\nAllocate one read group set per file per sample. For BAM files, read\ngroups are considered to share a sample if they have identical sample\nnames. Furthermore, all reads for each file which do not belong to a read\ngroup, if any, will be grouped into a single read group set per-file.",
- "Includes all read groups in all imported files into a single read group\nset. Requires that the headers for all imported files are equivalent. All\nreads which do not belong to a read group, if any, will be grouped into a\nseparate read group set."
- ],
- "enum": [
- "PARTITION_STRATEGY_UNSPECIFIED",
- "PER_FILE_PER_SAMPLE",
- "MERGE_ALL"
- ],
- "description": "The partition strategy describes how read groups are partitioned into read\ngroup sets.",
- "type": "string"
- },
"datasetId": {
"type": "string",
"description": "Required. The ID of the dataset these read group sets will belong to. The\ncaller must have WRITE permissions to this dataset."
@@ -2980,16 +3002,35 @@
"items": {
"type": "string"
}
+ },
+ "referenceSetId": {
+ "description": "The reference set to which the imported read group sets are aligned to, if\nany. The reference names of this reference set must be a superset of those\nfound in the imported file headers. If no reference set id is provided, a\nbest effort is made to associate with a matching reference set.",
+ "type": "string"
+ },
+ "partitionStrategy": {
+ "description": "The partition strategy describes how read groups are partitioned into read\ngroup sets.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "In most cases, this strategy yields one read group set per file. This is\nthe default behavior.\n\nAllocate one read group set per file per sample. For BAM files, read\ngroups are considered to share a sample if they have identical sample\nnames. Furthermore, all reads for each file which do not belong to a read\ngroup, if any, will be grouped into a single read group set per-file.",
+ "Includes all read groups in all imported files into a single read group\nset. Requires that the headers for all imported files are equivalent. All\nreads which do not belong to a read group, if any, will be grouped into a\nseparate read group set."
+ ],
+ "enum": [
+ "PARTITION_STRATEGY_UNSPECIFIED",
+ "PER_FILE_PER_SAMPLE",
+ "MERGE_ALL"
+ ]
}
},
- "id": "ImportReadGroupSetsRequest"
+ "id": "ImportReadGroupSetsRequest",
+ "description": "The read group set import request."
},
"Policy": {
"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",
- "type": "string"
+ "format": "byte"
},
"version": {
"description": "Version of the `Policy`. The default version is 0.",
@@ -2997,7 +3038,7 @@
"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.",
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"type": "array",
"items": {
"$ref": "Binding"
@@ -3035,8 +3076,8 @@
"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"
+ "$ref": "VariantAnnotation",
+ "description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`."
},
"id": {
"description": "The server-generated annotation ID, unique across all annotations.",
@@ -3047,14 +3088,21 @@
"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"
+ "type": "boolean",
+ "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."
},
"referenceName": {
"description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
"type": "string"
},
"type": {
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ],
"description": "The data type for this annotation. Must match the containing annotation\nset's type.",
"type": "string",
"enumDescriptions": [
@@ -3063,13 +3111,6 @@
"A `VARIANT` annotation type.",
"A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
"A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
- ],
- "enum": [
- "ANNOTATION_TYPE_UNSPECIFIED",
- "GENERIC",
- "VARIANT",
- "GENE",
- "TRANSCRIPT"
]
},
"info": {
@@ -3086,15 +3127,26 @@
"id": "Annotation"
},
"CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
"properties": {},
- "id": "CancelOperationRequest"
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object"
},
"SearchReadsRequest": {
"description": "The read search request.",
"type": "object",
"properties": {
+ "referenceName": {
+ "description": "The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to\n`*`, only unmapped reads are returned. If unspecified, all reads (mapped\nand unmapped) are returned.",
+ "type": "string"
+ },
+ "readGroupSetIds": {
+ "description": "The IDs of the read groups sets within which to search for reads. All\nspecified read group sets must be aligned against a common set of reference\nsequences; this defines the genomic coordinates for the query. Must specify\none of `readGroupSetIds` or `readGroupIds`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"readGroupIds": {
"description": "The IDs of the read groups within which to search for reads. All specified\nread groups must belong to the same read group sets. Must specify one of\n`readGroupSetIds` or `readGroupIds`.",
"type": "array",
@@ -3108,78 +3160,67 @@
"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",
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response."
},
"pageSize": {
- "type": "integer",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"start": {
"description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified.",
"format": "int64",
"type": "string"
- },
- "referenceName": {
- "description": "The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to\n`*`, only unmapped reads are returned. If unspecified, all reads (mapped\nand unmapped) are returned.",
- "type": "string"
- },
- "readGroupSetIds": {
- "description": "The IDs of the read groups sets within which to search for reads. All\nspecified read group sets must be aligned against a common set of reference\nsequences; this defines the genomic coordinates for the query. Must specify\none of `readGroupSetIds` or `readGroupIds`.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
"id": "SearchReadsRequest"
},
"RuntimeMetadata": {
+ "id": "RuntimeMetadata",
"description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
"type": "object",
"properties": {
"computeEngine": {
- "$ref": "ComputeEngine",
- "description": "Execution information specific to Google Compute Engine."
+ "description": "Execution information specific to Google Compute Engine.",
+ "$ref": "ComputeEngine"
}
- },
- "id": "RuntimeMetadata"
+ }
},
"Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
"properties": {
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "description": "An OperationMetadata object. This will always be returned with the Operation.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"response": {
"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": "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"
+ "type": "string",
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "description": "An OperationMetadata object. This will always be returned with the Operation.",
+ "type": "object"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"ImportReadGroupSetsResponse": {
"description": "The read group set import response.",
@@ -3196,6 +3237,7 @@
"id": "ImportReadGroupSetsResponse"
},
"VariantCall": {
+ "description": "A call represents the determination of genotype with respect to a particular\nvariant. It may include associated information such as quality and phasing.\nFor example, a call might assign a probability of 0.32 to the occurrence of\na SNP named rs1234 in a call set with the name NA12345.",
"type": "object",
"properties": {
"phaseset": {
@@ -3203,18 +3245,18 @@
"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": {
- "type": "string",
- "description": "The name of the call set this variant call belongs to."
+ "description": "The name of the call set this variant call belongs to.",
+ "type": "string"
},
"genotypeLikelihood": {
"description": "The genotype likelihoods for this variant call. Each array entry\nrepresents how likely a specific genotype is for this call. The value\nordering is defined by the GL tag in the VCF spec.\nIf Phred-scaled genotype likelihood scores (PL) are available and\nlog10(P) genotype likelihood scores (GL) are not, PL scores are converted\nto GL scores. If both are available, PL scores are stored in `info`.",
@@ -3237,28 +3279,28 @@
}
}
},
- "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."
+ "id": "VariantCall"
},
"SearchVariantsResponse": {
"description": "The variant search response.",
"type": "object",
"properties": {
- "variants": {
- "type": "array",
- "items": {
- "$ref": "Variant"
- },
- "description": "The list of matching Variants."
- },
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
+ },
+ "variants": {
+ "description": "The list of matching Variants.",
+ "type": "array",
+ "items": {
+ "$ref": "Variant"
+ }
}
},
"id": "SearchVariantsResponse"
},
"ListBasesResponse": {
+ "type": "object",
"properties": {
"sequence": {
"description": "A substring of the bases that make up this reference.",
@@ -3274,18 +3316,13 @@
"type": "string"
}
},
- "id": "ListBasesResponse",
- "type": "object"
+ "id": "ListBasesResponse"
},
"Status": {
+ "id": "Status",
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
@@ -3294,20 +3331,24 @@
"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": {
- "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"
+ }
},
"UndeleteDatasetRequest": {
- "type": "object",
"properties": {},
- "id": "UndeleteDatasetRequest"
+ "id": "UndeleteDatasetRequest",
+ "type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
@@ -3321,59 +3362,52 @@
}
},
"role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
+ "type": "string",
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
}
},
"id": "Binding"
},
"Range": {
- "type": "object",
"properties": {
- "start": {
- "description": "The start position of the range on the reference, 0-based inclusive.",
- "format": "int64",
- "type": "string"
- },
"end": {
"description": "The end position of the range on the reference, 0-based exclusive.",
"format": "int64",
"type": "string"
},
"referenceName": {
- "description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`.",
+ "type": "string",
+ "description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`."
+ },
+ "start": {
+ "description": "The start position of the range on the reference, 0-based inclusive.",
+ "format": "int64",
"type": "string"
}
},
"id": "Range",
- "description": "A 0-based half-open genomic coordinate range for search requests."
+ "description": "A 0-based half-open genomic coordinate range for search requests.",
+ "type": "object"
},
"VariantSet": {
+ "id": "VariantSet",
"description": "A variant set is a collection of call sets and variants. It contains summary\nstatistics of those contents. A variant set belongs to a dataset.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
- "description": {
- "description": "A textual description of this variant set.",
- "type": "string"
- },
- "datasetId": {
- "description": "The dataset to which this variant set belongs.",
- "type": "string"
- },
"name": {
- "description": "User-specified, mutable name.",
- "type": "string"
+ "type": "string",
+ "description": "User-specified, mutable name."
},
"referenceSetId": {
"description": "The reference set to which the variant set is mapped. The reference set\ndescribes the alignment provenance of the variant set, while the\n`referenceBounds` describe the shape of the actual variant data. The\nreference set's reference names are a superset of those found in the\n`referenceBounds`.\n\nFor example, given a variant set that is mapped to the GRCh38 reference set\nand contains a single variant on reference 'X', `referenceBounds` would\ncontain only an entry for 'X', while the associated reference set\nenumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.",
"type": "string"
},
"metadata": {
- "description": "The metadata associated with this variant set.",
"type": "array",
"items": {
"$ref": "VariantSetMetadata"
- }
+ },
+ "description": "The metadata associated with this variant set."
},
"referenceBounds": {
"description": "A list of all references used by the variants in a variant set\nwith associated coordinate upper bounds for each one.",
@@ -3385,11 +3419,19 @@
"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"
+ }
},
"BatchCreateAnnotationsResponse": {
+ "type": "object",
"properties": {
"entries": {
"description": "The resulting per-annotation entries, ordered consistently with the\noriginal request.",
@@ -3399,101 +3441,63 @@
}
}
},
- "id": "BatchCreateAnnotationsResponse",
- "type": "object"
+ "id": "BatchCreateAnnotationsResponse"
},
"ReferenceBound": {
"description": "ReferenceBound records an upper bound for the starting coordinate of\nvariants in a particular reference.",
"type": "object",
"properties": {
+ "upperBound": {
+ "description": "An upper bound (inclusive) on the starting coordinate of any\nvariant in the reference sequence.",
+ "format": "int64",
+ "type": "string"
+ },
"referenceName": {
"description": "The name of the reference associated with this reference bound.",
"type": "string"
- },
- "upperBound": {
- "type": "string",
- "description": "An upper bound (inclusive) on the starting coordinate of any\nvariant in the reference sequence.",
- "format": "int64"
}
},
"id": "ReferenceBound"
},
- "SearchCallSetsResponse": {
- "description": "The call set search response.",
- "type": "object",
+ "ListOperationsResponse": {
"properties": {
"nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "description": "The standard List next-page token.",
"type": "string"
},
- "callSets": {
- "description": "The list of matching call sets.",
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
- "$ref": "CallSet"
+ "$ref": "Operation"
}
}
},
- "id": "SearchCallSetsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"Variant": {
- "description": "A variant represents a change in DNA sequence relative to a reference\nsequence. For example, a variant could represent a SNP or an insertion.\nVariants belong to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach of the calls on a variant represent a determination of genotype with\nrespect to that variant. For example, a call might assign probability of 0.32\nto the occurrence of a SNP named rs1234 in a sample named NA12345. A call\nbelongs to a call set, which contains related calls typically from one\nsample.",
"type": "object",
"properties": {
- "variantSetId": {
- "description": "The ID of the variant set this variant belongs to.",
- "type": "string"
- },
- "referenceName": {
- "description": "The reference on which this variant occurs.\n(such as `chr20` or `X`)",
- "type": "string"
- },
- "info": {
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "description": "A map of additional variant information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
- },
- "referenceBases": {
- "description": "The reference bases for this variant. They start at the given\nposition.",
- "type": "string"
- },
- "alternateBases": {
+ "filter": {
"type": "array",
"items": {
"type": "string"
},
- "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"
- }
+ "description": "A list of filters (normally quality filters) this variant has failed.\n`PASS` indicates this variant has passed all filters."
},
"end": {
"description": "The end position (0-based) of this variant. This corresponds to the first\nbase after the last base in the reference allele. So, the length of\nthe reference allele is (end - start). This is useful for variants\nthat don't explicitly give alternate bases, for example large deletions.",
"format": "int64",
"type": "string"
},
- "filter": {
- "description": "A list of filters (normally quality filters) this variant has failed.\n`PASS` indicates this variant has passed all filters.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"calls": {
- "description": "The variant calls for this particular variant. Each one represents the\ndetermination of genotype with respect to this variant.",
"type": "array",
"items": {
"$ref": "VariantCall"
- }
+ },
+ "description": "The variant calls for this particular variant. Each one represents the\ndetermination of genotype with respect to this variant."
},
"created": {
"description": "The date this variant was created, in milliseconds from the epoch.",
@@ -3511,58 +3515,85 @@
"type": "number"
},
"id": {
- "description": "The server-generated variant ID, unique across all variants.",
- "type": "string"
- }
- },
- "id": "Variant"
- },
- "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"
- }
+ "type": "string",
+ "description": "The server-generated variant ID, unique across all variants."
},
- "nextPageToken": {
- "description": "The standard List next-page token.",
+ "variantSetId": {
+ "description": "The ID of the variant set this variant belongs to.",
"type": "string"
- }
- },
- "id": "ListOperationsResponse"
- },
- "SearchVariantsRequest": {
- "type": "object",
- "properties": {
- "variantSetIds": {
- "description": "At most one variant set ID must be provided. Only variants from this\nvariant set will be returned. If omitted, a call set id must be included in\nthe request.",
+ },
+ "referenceName": {
+ "type": "string",
+ "description": "The reference on which this variant occurs.\n(such as `chr20` or `X`)"
+ },
+ "info": {
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "description": "A map of additional variant information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
+ },
+ "referenceBases": {
+ "description": "The reference bases for this variant. They start at the given\nposition.",
+ "type": "string"
+ },
+ "alternateBases": {
+ "description": "The bases that appear instead of the reference bases.",
"type": "array",
"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",
+ "names": {
+ "description": "Names for the variant, for example a RefSNP ID.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Variant",
+ "description": "A variant represents a change in DNA sequence relative to a reference\nsequence. For example, a variant could represent a SNP or an insertion.\nVariants belong to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach of the calls on a variant represent a determination of genotype with\nrespect to that variant. For example, a call might assign probability of 0.32\nto the occurrence of a SNP named rs1234 in a sample named NA12345. A call\nbelongs to a call set, which contains related calls typically from one\nsample."
+ },
+ "SearchCallSetsResponse": {
+ "id": "SearchCallSetsResponse",
+ "description": "The call set search response.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
},
+ "callSets": {
+ "description": "The list of matching call sets.",
+ "type": "array",
+ "items": {
+ "$ref": "CallSet"
+ }
+ }
+ }
+ },
+ "SearchVariantsRequest": {
+ "id": "SearchVariantsRequest",
+ "description": "The variant search request.",
+ "type": "object",
+ "properties": {
"maxCalls": {
+ "type": "integer",
"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",
- "type": "integer"
+ "format": "int32"
},
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
},
"pageSize": {
+ "type": "integer",
"description": "The maximum number of variants to return in a single page. If unspecified,\ndefaults to 5000. The maximum value is 10000.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"callSetIds": {
"description": "Only return variant calls which belong to call sets with these ids.\nLeaving this blank returns all variant calls. If a variant has no\ncalls belonging to any of these call sets, it won't be returned at all.",
@@ -3583,10 +3614,20 @@
"referenceName": {
"description": "Required. Only return variants in this reference sequence.",
"type": "string"
+ },
+ "variantSetIds": {
+ "description": "At most one variant set ID must be provided. Only variants from this\nvariant set will be returned. If omitted, a call set id must be included in\nthe request.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "end": {
+ "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",
- "description": "The variant search request."
+ }
},
"OperationMetadata": {
"description": "Metadata describing an Operation.",
@@ -3619,26 +3660,26 @@
},
"request": {
"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 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": {
- "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": "Runtime metadata on this Operation.",
"type": "object"
},
"labels": {
- "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "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.",
@@ -3649,15 +3690,8 @@
"id": "OperationMetadata"
},
"SearchReadGroupSetsRequest": {
- "id": "SearchReadGroupSetsRequest",
- "description": "The read group set search request.",
"type": "object",
"properties": {
- "pageSize": {
- "type": "integer",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 1024.",
- "format": "int32"
- },
"datasetIds": {
"description": "Restricts this query to read group sets within the given datasets. At least\none ID must be provided.",
"type": "array",
@@ -3672,8 +3706,15 @@
"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 1024.",
+ "format": "int32",
+ "type": "integer"
}
- }
+ },
+ "id": "SearchReadGroupSetsRequest",
+ "description": "The read group set search request."
},
"SearchAnnotationsResponse": {
"type": "object",
@@ -3683,11 +3724,11 @@
"type": "string"
},
"annotations": {
- "description": "The matching annotations.",
"type": "array",
"items": {
"$ref": "Annotation"
- }
+ },
+ "description": "The matching annotations."
}
},
"id": "SearchAnnotationsResponse"
@@ -3695,123 +3736,82 @@
"ClinicalCondition": {
"type": "object",
"properties": {
- "conceptId": {
- "description": "The MedGen concept id associated with this gene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/",
- "type": "string"
- },
- "names": {
- "description": "A set of names for the condition.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
}
+ },
+ "conceptId": {
+ "description": "The MedGen concept id associated with this gene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/",
+ "type": "string"
+ },
+ "names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A set of names for the condition."
+ },
+ "omimId": {
+ "description": "The OMIM id for this condition.\nSearch for these IDs at http://omim.org/",
+ "type": "string"
}
},
"id": "ClinicalCondition"
},
"SearchReadsResponse": {
- "description": "The read search response.",
- "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
"alignments": {
"description": "The list of matching alignments sorted by mapped genomic coordinate,\nif any, ascending in position within the same reference. Unmapped reads,\nwhich have no position, are returned contiguously and are sorted in\nascending lexicographic order by fragment name.",
"type": "array",
"items": {
"$ref": "Read"
}
- },
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
}
},
- "id": "SearchReadsResponse"
- },
- "Program": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The display name of the program. This is typically the colloquial name of\nthe tool used, for example 'bwa' or 'picard'."
- },
- "commandLine": {
- "description": "The command line used to run this program.",
- "type": "string"
- },
- "prevProgramId": {
- "description": "The ID of the program run before this one.",
- "type": "string"
- },
- "id": {
- "description": "The user specified locally unique ID of the program. Used along with\n`prevProgramId` to define an ordering between programs.",
- "type": "string"
- },
- "version": {
- "description": "The version of the program run.",
- "type": "string"
- }
- },
- "id": "Program"
- },
- "ComputeEngine": {
- "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
- "type": "object",
- "properties": {
- "instanceName": {
- "type": "string",
- "description": "The instance on which the operation is running."
- },
- "zone": {
- "description": "The availability zone in which the instance resides.",
- "type": "string"
- },
- "machineType": {
- "description": "The machine type of the instance.",
- "type": "string"
- },
- "diskNames": {
- "description": "The names of the disks that were created for this pipeline.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ComputeEngine"
- },
- "CoverageBucket": {
- "description": "A bucket over which read coverage has been precomputed. A bucket corresponds\nto a specific range of the reference sequence.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The genomic coordinate range spanned by this bucket.",
- "$ref": "Range"
- },
- "meanCoverage": {
- "description": "The average number of reads which are aligned to each individual\nreference base in this bucket.",
- "format": "float",
- "type": "number"
- }
- },
- "id": "CoverageBucket"
+ "id": "SearchReadsResponse",
+ "description": "The read search response.",
+ "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",
"version": "v1",
- "baseUrl": "https://genomics.googleapis.com/"
+ "baseUrl": "https://genomics.googleapis.com/",
+ "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"
+ },
+ "https://www.googleapis.com/auth/genomics.readonly": {
+ "description": "View Genomics data"
+ },
+ "https://www.googleapis.com/auth/genomics": {
+ "description": "View and manage Genomics data"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Upload, process, query, and search Genomics data in the cloud.",
+ "servicePath": "",
+ "rootUrl": "https://genomics.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com"
}
diff --git a/genomics/v1/genomics-gen.go b/genomics/v1/genomics-gen.go
index 9025901..1bfdd88 100644
--- a/genomics/v1/genomics-gen.go
+++ b/genomics/v1/genomics-gen.go
@@ -1927,8 +1927,6 @@
// [IAM developer's guide](https://cloud.google.com/iam).
type Policy struct {
// 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"`
@@ -8528,7 +8526,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "path",
// "pattern": "^operations$",
// "required": true,
diff --git a/genomics/v1alpha2/genomics-api.json b/genomics/v1alpha2/genomics-api.json
index f898911..cfe0a1f 100644
--- a/genomics/v1alpha2/genomics-api.json
+++ b/genomics/v1alpha2/genomics-api.json
@@ -1,29 +1,51 @@
{
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "protocol": "rest",
+ "version": "v1alpha2",
+ "baseUrl": "https://genomics.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/compute": {
+ "description": "View and manage your Google Compute Engine resources"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/genomics": {
+ "description": "View and manage Genomics data"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Upload, process, query, and search Genomics data in the cloud.",
+ "servicePath": "",
+ "rootUrl": "https://genomics.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "genomics",
"batchPath": "batch",
- "revision": "20170509",
- "id": "genomics:v1alpha2",
"documentationLink": "https://cloud.google.com/genomics",
+ "id": "genomics:v1alpha2",
+ "revision": "20170603",
"title": "Genomics API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"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. 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"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
@@ -38,10 +60,17 @@
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1alpha2/operations/{operationsId}:cancel",
+ "path": "v1alpha2/{+name}:cancel",
"id": "genomics.operations.cancel",
- "path": "v1alpha2/{+name}:cancel"
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation."
},
"list": {
+ "flatPath": "v1alpha2/operations",
+ "path": "v1alpha2/{+name}",
+ "id": "genomics.operations.list",
"description": "Lists operations that match the specified filter in the request.",
"response": {
"$ref": "ListOperationsResponse"
@@ -51,121 +80,158 @@
],
"httpMethod": "GET",
"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.",
+ "description": "The name of the operation's parent resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^operations$",
+ "location": "path"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
"description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
"format": "int32",
"type": "integer"
+ },
+ "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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/operations",
- "path": "v1alpha2/{+name}",
- "id": "genomics.operations.list"
+ ]
},
"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"
],
- "response": {
- "$ref": "Operation"
- },
"parameters": {
"name": {
- "pattern": "^operations/.+$",
- "location": "path",
"description": "The name of the operation resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "flatPath": "v1alpha2/operations/{operationsId}",
- "id": "genomics.operations.get",
- "path": "v1alpha2/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ "flatPath": "v1alpha2/operations/{operationsId}"
}
}
},
"pipelines": {
"methods": {
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "pipelineId"
- ],
+ "create": {
"response": {
"$ref": "Pipeline"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1alpha2/pipelines",
+ "path": "v1alpha2/pipelines",
+ "id": "genomics.pipelines.create",
+ "request": {
+ "$ref": "Pipeline"
+ },
+ "description": "Creates a pipeline that can be run later. Create takes a Pipeline that\nhas all fields other than `pipelineId` populated, and then returns\nthe same pipeline with `pipelineId` populated. This id can be used\nto run the pipeline.\n\nCaller must have WRITE permission to the project."
+ },
+ "run": {
+ "flatPath": "v1alpha2/pipelines:run",
+ "path": "v1alpha2/pipelines:run",
+ "id": "genomics.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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "get": {
+ "response": {
+ "$ref": "Pipeline"
+ },
+ "parameterOrder": [
+ "pipelineId"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
"pipelineId": {
+ "location": "path",
"description": "Caller must have READ access to the project in which this pipeline\nis defined.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.get",
"path": "v1alpha2/pipelines/{pipelineId}",
+ "id": "genomics.pipelines.get",
"description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project."
},
"setOperationStatus": {
+ "flatPath": "v1alpha2/pipelines:setOperationStatus",
+ "id": "genomics.pipelines.setOperationStatus",
+ "path": "v1alpha2/pipelines:setOperationStatus",
+ "request": {
+ "$ref": "SetOperationStatusRequest"
+ },
+ "description": "Sets status of a given operation. Any new timestamps (as determined by\ndescription) are appended to TimestampEvents. Should only be called by VMs\ncreated by the Pipelines Service and not by end users.",
+ "httpMethod": "PUT",
+ "parameterOrder": [],
"response": {
"$ref": "Empty"
},
- "parameterOrder": [],
- "httpMethod": "PUT",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1alpha2/pipelines:setOperationStatus",
- "path": "v1alpha2/pipelines:setOperationStatus",
- "id": "genomics.pipelines.setOperationStatus",
- "description": "Sets status of a given operation. Any new timestamps (as determined by\ndescription) are appended to TimestampEvents. Should only be called by VMs\ncreated by the Pipelines Service and not by end users.",
- "request": {
- "$ref": "SetOperationStatusRequest"
- }
+ ]
},
"getControllerConfig": {
- "id": "genomics.pipelines.getControllerConfig",
+ "flatPath": "v1alpha2/pipelines:getControllerConfig",
"path": "v1alpha2/pipelines:getControllerConfig",
+ "id": "genomics.pipelines.getControllerConfig",
"description": "Gets controller configuration information. Should only be called\nby VMs created by the Pipelines Service and not by end users.",
- "httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "ControllerConfig"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
"operationId": {
"location": "query",
@@ -173,18 +239,21 @@
"type": "string"
},
"validationToken": {
- "format": "uint64",
"type": "string",
- "location": "query"
+ "location": "query",
+ "format": "uint64"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines:getControllerConfig"
+ ]
},
"delete": {
+ "flatPath": "v1alpha2/pipelines/{pipelineId}",
+ "path": "v1alpha2/pipelines/{pipelineId}",
+ "id": "genomics.pipelines.delete",
+ "description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project.",
"response": {
"$ref": "Empty"
},
@@ -203,39 +272,36 @@
"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",
- "description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project."
+ ]
},
"list": {
+ "description": "Lists pipelines.\n\nCaller must have READ permission to the project.",
"httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "ListPipelinesResponse"
},
+ "parameterOrder": [],
"parameters": {
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.",
- "format": "int32"
- },
- "projectId": {
- "location": "query",
- "description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.",
- "type": "string"
- },
"namePrefix": {
- "type": "string",
"location": "query",
- "description": "Pipelines with names that match this prefix should be\nreturned. If unspecified, all pipelines in the project, up to\n`pageSize`, will be returned."
+ "description": "Pipelines with names that match this prefix should be\nreturned. If unspecified, all pipelines in the project, up to\n`pageSize`, will be returned.",
+ "type": "string"
},
"pageToken": {
"description": "Token to use to indicate where to start getting results.\nIf unspecified, returns the first page of results.",
"type": "string",
"location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "projectId": {
+ "type": "string",
+ "location": "query",
+ "description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project."
}
},
"scopes": [
@@ -244,106 +310,22 @@
],
"flatPath": "v1alpha2/pipelines",
"id": "genomics.pipelines.list",
- "path": "v1alpha2/pipelines",
- "description": "Lists pipelines.\n\nCaller must have READ permission to the project."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Pipeline"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines",
- "id": "genomics.pipelines.create",
- "path": "v1alpha2/pipelines",
- "request": {
- "$ref": "Pipeline"
- },
- "description": "Creates a pipeline that can be run later. Create takes a Pipeline that\nhas all fields other than `pipelineId` populated, and then returns\nthe same pipeline with `pipelineId` populated. This id can be used\nto run the pipeline.\n\nCaller must have WRITE permission to the project."
- },
- "run": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines:run",
- "path": "v1alpha2/pipelines:run",
- "id": "genomics.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."
+ "path": "v1alpha2/pipelines"
}
}
}
},
"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": {
+ "access_token": {
"type": "string",
"location": "query",
- "description": "JSONP"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ]
+ "description": "OAuth access token."
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -355,16 +337,16 @@
"type": "boolean",
"default": "true"
},
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -375,470 +357,69 @@
"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": {
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
}
},
"schemas": {
- "LoggingOptions": {
- "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",
- "description": "The logging options for the pipeline run.",
- "type": "object"
- },
- "RunPipelineRequest": {
- "properties": {
- "pipelineArgs": {
- "description": "The arguments to use when running this pipeline.",
- "$ref": "RunPipelineArgs"
- },
- "pipelineId": {
- "description": "The already created pipeline to run.",
- "type": "string"
- },
- "ephemeralPipeline": {
- "$ref": "Pipeline",
- "description": "A new pipeline object to run once and then delete."
- }
- },
- "id": "RunPipelineRequest",
- "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": {
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation.",
- "type": "object"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "An OperationMetadata object. This will always be returned with the Operation.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "RuntimeMetadata": {
- "type": "object",
- "properties": {
- "computeEngine": {
- "description": "Execution information specific to Google Compute Engine.",
- "$ref": "ComputeEngine"
- }
- },
- "id": "RuntimeMetadata",
- "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution."
- },
- "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": {
- "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": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "code": {
- "type": "integer",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
- },
- "ServiceAccount": {
- "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",
- "description": "A Google Cloud Service Account."
- },
- "PipelineResources": {
- "id": "PipelineResources",
- "description": "The system resources for the pipeline run.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- }
- },
- "Pipeline": {
- "properties": {
- "inputParameters": {
- "description": "Input parameters of the pipeline.",
- "type": "array",
- "items": {
- "$ref": "PipelineParameter"
- }
- },
- "resources": {
- "description": "Required. Specifies resource requirements for the pipeline run.\nRequired fields:\n\n*\nminimumCpuCores\n\n*\nminimumRamGb",
- "$ref": "PipelineResources"
- },
- "name": {
- "type": "string",
- "description": "Required. A user specified pipeline name that does not have to be unique.\nThis name can be used for filtering Pipelines in ListPipelines."
- },
- "projectId": {
- "type": "string",
- "description": "Required. The project in which to create the pipeline. The caller must have\nWRITE access."
- },
- "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"
- }
- },
- "description": {
- "description": "User-specified description.",
- "type": "string"
- },
- "docker": {
- "$ref": "DockerExecutor",
- "description": "Specifies the docker run information."
- }
- },
- "id": "Pipeline",
- "description": "The pipeline object. Represents a transformation from a set of input\nparameters to a set of output parameters. The transformation is defined\nas a docker image and command to run within that image. Each pipeline\nis run on a Google Compute Engine VM. A pipeline can be created with the\n`create` method and then later run with the `run` method, or a pipeline can\nbe defined and run all at once with the `run` method.",
- "type": "object"
- },
- "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": {
- "disks": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "machineType": {
- "type": "string"
- },
- "cmd": {
- "type": "string"
- },
- "vars": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "image": {
- "type": "string"
- },
- "gcsLogPath": {
- "type": "string"
- },
- "gcsSources": {
- "type": "object",
- "additionalProperties": {
- "$ref": "RepeatedString"
- }
- },
- "gcsSinks": {
- "additionalProperties": {
- "$ref": "RepeatedString"
- },
- "type": "object"
- }
- },
- "id": "ControllerConfig"
- },
- "OperationEvent": {
- "description": "An event that occurred during an Operation.",
- "type": "object",
- "properties": {
- "startTime": {
- "type": "string",
- "description": "Optional time of when event started.",
- "format": "google-datetime"
- },
- "description": {
- "description": "Required description of event.",
- "type": "string"
- },
- "endTime": {
- "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationEvent"
- },
- "ListOperationsResponse": {
- "type": "object",
- "properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations."
- },
- "RepeatedString": {
- "type": "object",
- "properties": {
- "values": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "RepeatedString"
- },
- "OperationMetadata": {
- "properties": {
- "createTime": {
- "description": "The time at which the job was submitted to the Genomics service.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "projectId": {
- "description": "The Google Cloud Project in which the job is scoped.",
- "type": "string"
- },
- "clientId": {
- "type": "string",
- "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation."
- },
- "events": {
- "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
- "type": "array",
- "items": {
- "$ref": "OperationEvent"
- }
- },
- "endTime": {
- "description": "The time at which the job stopped running.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "The time at which the job began to run.",
- "format": "google-datetime",
- "type": "string"
- },
- "request": {
- "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "runtimeMetadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Runtime metadata on this Operation.",
- "type": "object"
- }
- },
- "id": "OperationMetadata",
- "description": "Metadata describing an Operation.",
- "type": "object"
- },
- "RunPipelineArgs": {
- "properties": {
- "clientId": {
- "description": "This field is deprecated. Use `labels` instead. Client-specified pipeline\noperation identifier.",
- "type": "string"
- },
- "inputs": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Pipeline input arguments; keys are defined in the pipeline documentation.\nAll input parameters that do not have default values must be specified.\nIf parameters with defaults are specified here, the defaults will be\noverridden.",
- "type": "object"
- },
- "serviceAccount": {
- "$ref": "ServiceAccount",
- "description": "The Google Cloud Service Account that will be used to access data and\nservices. By default, the compute service account associated with\n`projectId` is used."
- },
- "logging": {
- "$ref": "LoggingOptions",
- "description": "Required. Logging options. Used by the service to communicate results\nto the user."
- },
- "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"
- },
- "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"
- },
- "resources": {
- "$ref": "PipelineResources",
- "description": "Specifies resource requirements/overrides for the pipeline run."
- },
- "keepVmAliveOnFailureDuration": {
- "description": "How long to keep the VM up after a failure (for example docker command\nfailed, copying input or output files failed, etc). While the VM is up, one\ncan ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.",
- "format": "google-duration",
- "type": "string"
- },
- "projectId": {
- "description": "Required. The project in which to run the pipeline. The caller must have\nWRITER access to all Google Cloud services and resources (e.g. Google\nCompute Engine) will be used.",
- "type": "string"
- }
- },
- "id": "RunPipelineArgs",
- "description": "The pipeline run arguments.",
- "type": "object"
- },
- "ListPipelinesResponse": {
- "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",
- "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."
- },
"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",
"properties": {
+ "operationId": {
+ "type": "string"
+ },
+ "errorMessage": {
+ "type": "string"
+ },
+ "validationToken": {
+ "format": "uint64",
+ "type": "string"
+ },
"errorCode": {
+ "type": "string",
"enumDescriptions": [
"Not an error; returned on success\n\nHTTP Mapping: 200 OK",
"The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request",
@@ -876,28 +457,20 @@
"INTERNAL",
"UNAVAILABLE",
"DATA_LOSS"
- ],
- "type": "string"
+ ]
},
"timestampEvents": {
"type": "array",
"items": {
"$ref": "TimestampEvent"
}
- },
- "operationId": {
- "type": "string"
- },
- "errorMessage": {
- "type": "string"
- },
- "validationToken": {
- "format": "uint64",
- "type": "string"
}
- }
+ },
+ "id": "SetOperationStatusRequest"
},
"ComputeEngine": {
+ "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
+ "type": "object",
"properties": {
"zone": {
"description": "The availability zone in which the instance resides.",
@@ -919,12 +492,9 @@
"type": "string"
}
},
- "id": "ComputeEngine",
- "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
- "type": "object"
+ "id": "ComputeEngine"
},
"ImportVariantsResponse": {
- "description": "The variant data import response.",
"type": "object",
"properties": {
"callSetIds": {
@@ -935,25 +505,27 @@
}
}
},
- "id": "ImportVariantsResponse"
+ "id": "ImportVariantsResponse",
+ "description": "The variant data import response."
},
"TimestampEvent": {
+ "id": "TimestampEvent",
"description": "Stores the list of events and times they occured for major events in job\nexecution.",
"type": "object",
"properties": {
"description": {
- "type": "string",
- "description": "String indicating the type of event"
+ "description": "String indicating the type of event",
+ "type": "string"
},
"timestamp": {
"description": "The time this event occured.",
"format": "google-datetime",
"type": "string"
}
- },
- "id": "TimestampEvent"
+ }
},
"LocalCopy": {
+ "description": "LocalCopy defines how a remote file should be copied to and from the VM.",
"type": "object",
"properties": {
"path": {
@@ -965,35 +537,38 @@
"type": "string"
}
},
- "id": "LocalCopy",
- "description": "LocalCopy defines how a remote file should be copied to and from the VM."
+ "id": "LocalCopy"
},
"DockerExecutor": {
"description": "The Docker execuctor specification.",
"type": "object",
"properties": {
"cmd": {
- "type": "string",
- "description": "Required. The command or newline delimited script to run. The command\nstring will be executed within a bash shell.\n\nIf the command exits with a non-zero exit code, output parameter\nde-localization will be skipped and the pipeline operation's\n`error` field will be populated.\n\nMaximum command string length is 16384."
+ "description": "Required. The command or newline delimited script to run. The command\nstring will be executed within a bash shell.\n\nIf the command exits with a non-zero exit code, output parameter\nde-localization will be skipped and the pipeline operation's\n`error` field will be populated.\n\nMaximum command string length is 16384.",
+ "type": "string"
},
"imageName": {
- "description": "Required. Image name from either Docker Hub or Google Container Registry.\nUsers that run pipelines must have READ access to the image.",
- "type": "string"
+ "type": "string",
+ "description": "Required. Image name from either Docker Hub or Google Container Registry.\nUsers that run pipelines must have READ access to the image."
}
},
"id": "DockerExecutor"
},
+ "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"
+ },
"Disk": {
"description": "A Google Compute Engine disk resource specification.",
"type": "object",
"properties": {
+ "name": {
+ "description": "Required. The name of the disk that can be used in the pipeline\nparameters. Must be 1 - 63 characters.\nThe name \"boot\" is reserved for system use.",
+ "type": "string"
+ },
"type": {
- "enumDescriptions": [
- "Default disk type. Use one of the other options below.",
- "Specifies a Google Compute Engine persistent hard disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
- "Specifies a Google Compute Engine persistent solid-state disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
- "Specifies a Google Compute Engine local SSD.\nSee https://cloud.google.com/compute/docs/disks/local-ssd for details."
- ],
"enum": [
"TYPE_UNSPECIFIED",
"PERSISTENT_HDD",
@@ -1001,7 +576,13 @@
"LOCAL_SSD"
],
"description": "Required. The type of the disk to create.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Default disk type. Use one of the other options below.",
+ "Specifies a Google Compute Engine persistent hard disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
+ "Specifies a Google Compute Engine persistent solid-state disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
+ "Specifies a Google Compute Engine local SSD.\nSee https://cloud.google.com/compute/docs/disks/local-ssd for details."
+ ]
},
"autoDelete": {
"description": "Deprecated. Disks created by the Pipelines API will be deleted at the end\nof the pipeline run, regardless of what this field is set to.",
@@ -1023,21 +604,13 @@
"source": {
"description": "The full or partial URL of the persistent disk to attach. See\nhttps://cloud.google.com/compute/docs/reference/latest/instances#resource\nand\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#snapshots\nfor more details.",
"type": "string"
- },
- "name": {
- "description": "Required. The name of the disk that can be used in the pipeline\nparameters. Must be 1 - 63 characters.\nThe name \"boot\" is reserved for system use.",
- "type": "string"
}
},
"id": "Disk"
},
- "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 `{}`."
- },
"PipelineParameter": {
+ "id": "PipelineParameter",
+ "description": "Parameters facilitate setting and delivering data into the\npipeline's execution environment. They are defined at create time,\nwith optional defaults, and can be overridden at run time.\n\nIf `localCopy` is unset, then the parameter specifies a string that\nis passed as-is into the pipeline, as the value of the environment\nvariable with the given name. A default value can be optionally\nspecified at create time. The default can be overridden at run time\nusing the inputs map. If no default is given, a value must be\nsupplied at runtime.\n\nIf `localCopy` is defined, then the parameter specifies a data\nsource or sink, both in Google Cloud Storage and on the Docker container\nwhere the pipeline computation is run. The service account associated with\nthe Pipeline (by\ndefault the project's Compute Engine service account) must have access to the\nGoogle Cloud Storage paths.\n\nAt run time, the Google Cloud Storage paths can be overridden if a default\nwas provided at create time, or must be set otherwise. The pipeline runner\nshould add a key/value pair to either the inputs or outputs map. The\nindicated data copies will be carried out before/after pipeline execution,\njust as if the corresponding arguments were provided to `gsutil cp`.\n\nFor example: Given the following `PipelineParameter`, specified\nin the `inputParameters` list:\n\n```\n{name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}}\n```\n\nwhere `disk` is defined in the `PipelineResources` object as:\n\n```\n{name: \"pd1\", mountPoint: \"/mnt/disk/\"}\n```\n\nWe create a disk named `pd1`, mount it on the host VM, and map\n`/mnt/pd1` to `/mnt/disk` in the docker container. At\nruntime, an entry for `input_file` would be required in the inputs\nmap, such as:\n\n```\n inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\"\n```\n\nThis would generate the following gsutil call:\n\n```\n gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt\n```\n\nThe file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the\nDocker container. Acceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eGoogle Cloud storage path\u003c/th\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\u003ctd\u003eglob\u003c/td\u003e\u003ctd\u003edirectory\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor outputs, the direction of the copy is reversed:\n\n```\n gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt\n```\n\nAcceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003cth\u003eGoogle Cloud Storage path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003efile\u003c/td\u003e\n \u003ctd\u003edirectory - directory must already exist\u003c/td\u003e\n \u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003eglob\u003c/td\u003e\n \u003ctd\u003edirectory - directory will be created if it doesn't exist\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nOne restriction due to docker limitations, is that for outputs that are found\non the boot disk, the local path cannot be a glob and must be a file.",
"type": "object",
"properties": {
"localCopy": {
@@ -1056,35 +629,462 @@
"description": "Human-readable description.",
"type": "string"
}
+ }
+ },
+ "LoggingOptions": {
+ "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": "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."
- }
- },
- "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": "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"
+ "id": "LoggingOptions",
+ "description": "The logging options for the pipeline run."
+ },
+ "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"
},
- "https://www.googleapis.com/auth/genomics": {
- "description": "View and manage Genomics data"
+ "ephemeralPipeline": {
+ "$ref": "Pipeline",
+ "description": "A new pipeline object to run once and then delete."
},
- "https://www.googleapis.com/auth/compute": {
- "description": "View and manage your Google Compute Engine resources"
+ "pipelineArgs": {
+ "$ref": "RunPipelineArgs",
+ "description": "The arguments to use when running this pipeline."
+ }
+ },
+ "id": "RunPipelineRequest"
+ },
+ "CancelOperationRequest": {
+ "properties": {},
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "An OperationMetadata object. This will always be returned with the Operation.",
+ "type": "object"
}
}
+ },
+ "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": {
+ "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",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
+ },
+ "ServiceAccount": {
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "Email address of the service account. Defaults to `default`,\nwhich uses the compute service account associated with the project."
+ },
+ "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",
+ "description": "A Google Cloud Service Account.",
+ "type": "object"
+ },
+ "PipelineResources": {
+ "description": "The system resources for the pipeline run.",
+ "type": "object",
+ "properties": {
+ "bootDiskSizeGb": {
+ "description": "The size of the boot disk. Defaults to 10 (GB).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen."
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "outputParameters": {
+ "description": "Output parameters of the pipeline.",
+ "type": "array",
+ "items": {
+ "$ref": "PipelineParameter"
+ }
+ },
+ "description": {
+ "description": "User-specified description.",
+ "type": "string"
+ },
+ "docker": {
+ "$ref": "DockerExecutor",
+ "description": "Specifies the docker run information."
+ },
+ "inputParameters": {
+ "description": "Input parameters of the pipeline.",
+ "type": "array",
+ "items": {
+ "$ref": "PipelineParameter"
+ }
+ },
+ "resources": {
+ "$ref": "PipelineResources",
+ "description": "Required. Specifies resource requirements for the pipeline run.\nRequired fields:\n\n*\nminimumCpuCores\n\n*\nminimumRamGb"
+ },
+ "name": {
+ "description": "Required. A user specified pipeline name that does not have to be unique.\nThis name can be used for filtering Pipelines in ListPipelines.",
+ "type": "string"
+ },
+ "pipelineId": {
+ "description": "Unique pipeline id that is generated by the service when CreatePipeline\nis called. Cannot be specified in the Pipeline used in the\nCreatePipelineRequest, and will be populated in the response to\nCreatePipeline and all subsequent Get and List calls. Indicates that the\nservice has registered this pipeline.",
+ "type": "string"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "Required. The project in which to create the pipeline. The caller must have\nWRITE access."
+ }
+ },
+ "id": "Pipeline"
+ },
+ "OperationEvent": {
+ "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",
+ "description": "An event that occurred during an Operation."
+ },
+ "ControllerConfig": {
+ "id": "ControllerConfig",
+ "description": "Stores the information that the controller will fetch from the\nserver in order to run. Should only be used by VMs created by the\nPipelines Service and not by end users.",
+ "type": "object",
+ "properties": {
+ "gcsSinks": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "RepeatedString"
+ }
+ },
+ "disks": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "machineType": {
+ "type": "string"
+ },
+ "cmd": {
+ "type": "string"
+ },
+ "vars": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "image": {
+ "type": "string"
+ },
+ "gcsLogPath": {
+ "type": "string"
+ },
+ "gcsSources": {
+ "additionalProperties": {
+ "$ref": "RepeatedString"
+ },
+ "type": "object"
+ }
+ }
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "RepeatedString": {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "RepeatedString"
+ },
+ "OperationMetadata": {
+ "id": "OperationMetadata",
+ "description": "Metadata describing an Operation.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "createTime": {
+ "type": "string",
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "format": "google-datetime"
+ },
+ "projectId": {
+ "description": "The Google Cloud Project in which the job is scoped.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "ListPipelinesResponse": {
+ "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",
+ "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"
+ },
+ "RunPipelineArgs": {
+ "properties": {
+ "labels": {
+ "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "logging": {
+ "$ref": "LoggingOptions",
+ "description": "Required. Logging options. Used by the service to communicate results\nto the user."
+ },
+ "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"
+ },
+ "resources": {
+ "description": "Specifies resource requirements/overrides for the pipeline run.",
+ "$ref": "PipelineResources"
+ },
+ "keepVmAliveOnFailureDuration": {
+ "description": "How long to keep the VM up after a failure (for example docker command\nfailed, copying input or output files failed, etc). While the VM is up, one\ncan ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Required. The project in which to run the pipeline. The caller must have\nWRITER access to all Google Cloud services and resources (e.g. Google\nCompute Engine) will be used.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "This field is deprecated. Use `labels` instead. Client-specified pipeline\noperation identifier.",
+ "type": "string"
+ },
+ "inputs": {
+ "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",
+ "additionalProperties": {
+ "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."
+ }
+ },
+ "id": "RunPipelineArgs",
+ "description": "The pipeline run arguments.",
+ "type": "object"
}
- },
- "kind": "discovery#restDescription",
- "description": "Upload, process, query, and search Genomics data in the cloud.",
- "servicePath": "",
- "rootUrl": "https://genomics.googleapis.com/"
+ }
}
diff --git a/genomics/v1alpha2/genomics-gen.go b/genomics/v1alpha2/genomics-gen.go
index 179a968..51ce308 100644
--- a/genomics/v1alpha2/genomics-gen.go
+++ b/genomics/v1alpha2/genomics-gen.go
@@ -2081,7 +2081,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "path",
// "pattern": "^operations$",
// "required": true,
diff --git a/gmail/v1/gmail-api.json b/gmail/v1/gmail-api.json
index acbfefc..1e14038 100644
--- a/gmail/v1/gmail-api.json
+++ b/gmail/v1/gmail-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/UwagAxm_I2G-u6KLgFC6FvmGYn8\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/sp6jQ8V0i8GKNN9WuCJbaCVJmmQ\"",
"discoveryVersion": "v1",
"id": "gmail:v1",
"name": "gmail",
"version": "v1",
- "revision": "20170405",
+ "revision": "20170510",
"title": "Gmail API",
"description": "Access Gmail mailboxes including sending user email.",
"ownerDomain": "google.com",
@@ -2138,7 +2138,7 @@
},
"q": {
"type": "string",
- "description": "Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, \"from:someuser@example.com rfc822msgid: is:unread\". Parameter cannot be used when accessing the api using the gmail.metadata scope.",
+ "description": "Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, \"from:someuser@example.com rfc822msgid:\u003csomemsgid@example.com\u003e is:unread\". Parameter cannot be used when accessing the api using the gmail.metadata scope.",
"location": "query"
},
"userId": {
diff --git a/gmail/v1/gmail-gen.go b/gmail/v1/gmail-gen.go
index 1421cc0..0378845 100644
--- a/gmail/v1/gmail-gen.go
+++ b/gmail/v1/gmail-gen.go
@@ -5856,9 +5856,9 @@
// Q sets the optional parameter "q": Only return messages matching the
// specified query. Supports the same query format as the Gmail search
-// box. For example, "from:someuser@example.com rfc822msgid: is:unread".
-// Parameter cannot be used when accessing the api using the
-// gmail.metadata scope.
+// box. For example, "from:someuser@example.com
+// rfc822msgid:<somemsgid@example.com> is:unread". Parameter cannot be
+// used when accessing the api using the gmail.metadata scope.
func (c *UsersMessagesListCall) Q(q string) *UsersMessagesListCall {
c.urlParams_.Set("q", q)
return c
@@ -5990,7 +5990,7 @@
// "type": "string"
// },
// "q": {
- // "description": "Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, \"from:someuser@example.com rfc822msgid: is:unread\". Parameter cannot be used when accessing the api using the gmail.metadata scope.",
+ // "description": "Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, \"from:someuser@example.com rfc822msgid:\u003csomemsgid@example.com\u003e is:unread\". Parameter cannot be used when accessing the api using the gmail.metadata scope.",
// "location": "query",
// "type": "string"
// },
diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json
index 98df2ec..26eefd4 100644
--- a/iam/v1/iam-api.json
+++ b/iam/v1/iam-api.json
@@ -1,16 +1,73 @@
{
- "kind": "discovery#restDescription",
- "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.",
- "basePath": "",
- "id": "iam:v1",
+ "revision": "20170526",
"documentationLink": "https://cloud.google.com/iam/",
- "revision": "20170501",
+ "id": "iam:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "ServiceAccount": {
+ "description": "A service account in the Identity and Access Management API.\n\nTo create a service account, specify the `project_id` and the `account_id`\nfor the account. The `account_id` is unique within the project, and is used\nto generate the service account email address and a stable\n`unique_id`.\n\nIf the account already exists, the account's resource name is returned\nin util::Status's ResourceInfo.resource_name in the format of\nprojects/{PROJECT_ID}/serviceAccounts/{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": {
+ "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"
+ },
+ "uniqueId": {
+ "description": "@OutputOnly The unique and stable id of the service account.",
+ "type": "string"
+ },
+ "oauth2ClientId": {
+ "description": "@OutputOnly. The OAuth2 client id for the service account.\nThis is used in conjunction with the OAuth2 clientconfig API to make\nthree legged OAuth2 (3LO) flows to access the data of Google users.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Used to perform a consistent read-modify-write.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ServiceAccount"
+ },
+ "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"
+ },
+ "QueryGrantableRolesRequest": {
+ "description": "The grantable role query request.",
+ "type": "object",
+ "properties": {
+ "fullResourceName": {
+ "description": "Required. The full resource name to query from the list of grantable roles.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional limit on the number of roles to include in the response.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "QueryGrantableRolesRequest"
+ },
"ListServiceAccountKeysResponse": {
- "id": "ListServiceAccountKeysResponse",
"description": "The service account keys list response.",
"type": "object",
"properties": {
@@ -21,11 +78,10 @@
"$ref": "ServiceAccountKey"
}
}
- }
+ },
+ "id": "ListServiceAccountKeysResponse"
},
"TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -35,12 +91,19 @@
}
}
},
- "id": "TestIamPermissionsResponse"
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "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": {
+ "publicKeyData": {
+ "description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
+ "format": "byte",
+ "type": "string"
+ },
"name": {
"description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.",
"type": "string"
@@ -64,11 +127,35 @@
"description": "Specifies the algorithm (and possibly key size) for the key.",
"type": "string"
},
+ "privateKeyType": {
+ "description": "The output format for the private key.\nOnly provided in `CreateServiceAccountKey` responses, not\nin `GetServiceAccountKey` or `ListServiceAccountKey` responses.\n\nGoogle never exposes system-managed private keys, and never retains\nuser-managed private keys.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
+ "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
+ "Google Credentials File format."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TYPE_PKCS12_FILE",
+ "TYPE_GOOGLE_CREDENTIALS_FILE"
+ ]
+ },
"validAfterTime": {
"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"
+ }
+ },
+ "id": "ServiceAccountKey"
+ },
+ "CreateServiceAccountKeyRequest": {
+ "properties": {
"privateKeyType": {
"enumDescriptions": [
"Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
@@ -80,26 +167,12 @@
"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.",
+ "description": "The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the\ndefault output format.",
"type": "string"
},
- "privateKeyData": {
- "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses.",
- "format": "byte",
- "type": "string"
+ "includePublicKeyData": {
+ "type": "boolean"
},
- "publicKeyData": {
- "description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ServiceAccountKey"
- },
- "CreateServiceAccountKeyRequest": {
- "description": "The service account key create request.",
- "type": "object",
- "properties": {
"keyAlgorithm": {
"enumDescriptions": [
"An unspecified key algorithm.",
@@ -113,28 +186,13 @@
],
"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"
- },
- "privateKeyType": {
- "description": "The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the\ndefault output format.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
- "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
- "Google Credentials File format."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_PKCS12_FILE",
- "TYPE_GOOGLE_CREDENTIALS_FILE"
- ]
}
},
- "id": "CreateServiceAccountKeyRequest"
+ "id": "CreateServiceAccountKeyRequest",
+ "description": "The service account key create request.",
+ "type": "object"
},
"SignJwtResponse": {
- "id": "SignJwtResponse",
- "description": "The service account sign JWT response.",
- "type": "object",
"properties": {
"keyId": {
"description": "The id of the key used to sign the JWT.",
@@ -144,27 +202,28 @@
"description": "The signed JWT.",
"type": "string"
}
- }
+ },
+ "id": "SignJwtResponse",
+ "description": "The service account sign JWT response.",
+ "type": "object"
},
"SignBlobResponse": {
- "description": "The service account sign blob response.",
- "type": "object",
"properties": {
- "keyId": {
- "description": "The id of the key used to sign the blob.",
- "type": "string"
- },
"signature": {
"description": "The signed blob.",
"format": "byte",
"type": "string"
+ },
+ "keyId": {
+ "description": "The id of the key used to sign the blob.",
+ "type": "string"
}
},
- "id": "SignBlobResponse"
+ "id": "SignBlobResponse",
+ "description": "The service account sign blob response.",
+ "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).",
@@ -174,17 +233,25 @@
}
}
},
- "id": "TestIamPermissionsRequest"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "SignJwtRequest": {
+ "description": "The service account sign JWT request.",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "The JWT payload to sign, a JSON JWT Claim set.",
+ "type": "string"
+ }
+ },
+ "id": "SignJwtRequest"
},
"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",
@@ -196,23 +263,16 @@
"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"
},
- "SignJwtRequest": {
- "id": "SignJwtRequest",
- "description": "The service account sign JWT request.",
- "type": "object",
- "properties": {
- "payload": {
- "description": "The JWT payload to sign, a JSON JWT Claim set.",
- "type": "string"
- }
- }
- },
"AuditData": {
- "id": "AuditData",
"description": "Audit log information specific to Cloud IAM. This message is serialized\nas an `Any` type in the `ServiceData` message of an\n`AuditLog` message.",
"type": "object",
"properties": {
@@ -220,12 +280,19 @@
"$ref": "PolicyDelta",
"description": "Policy delta between the original policy and the newly set policy."
}
- }
+ },
+ "id": "AuditData"
},
"BindingDelta": {
- "description": "One delta entry for Binding. Each individual change (only one member in each\nentry) to a binding will be a separate entry.",
- "type": "object",
"properties": {
+ "member": {
+ "description": "A single identity requesting access for a Cloud Platform resource.\nFollows the same format of Binding.members.\nRequired",
+ "type": "string"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ },
"action": {
"description": "The action that was performed on a Binding.\nRequired",
"type": "string",
@@ -239,20 +306,13 @@
"ADD",
"REMOVE"
]
- },
- "member": {
- "description": "A single identity requesting access for a Cloud Platform resource.\nFollows the same format of Binding.members.\nRequired",
- "type": "string"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
}
},
- "id": "BindingDelta"
+ "id": "BindingDelta",
+ "description": "One delta entry for Binding. Each individual change (only one member in each\nentry) to a binding will be a separate entry.",
+ "type": "object"
},
"PolicyDelta": {
- "id": "PolicyDelta",
"description": "The difference delta between two policies.",
"type": "object",
"properties": {
@@ -263,15 +323,34 @@
"$ref": "BindingDelta"
}
}
- }
+ },
+ "id": "PolicyDelta"
+ },
+ "ListServiceAccountsResponse": {
+ "description": "The service account list response.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "To retrieve the next page of results, set\nListServiceAccountsRequest.page_token\nto this value.",
+ "type": "string"
+ },
+ "accounts": {
+ "description": "The list of matching service accounts.",
+ "type": "array",
+ "items": {
+ "$ref": "ServiceAccount"
+ }
+ }
+ },
+ "id": "ListServiceAccountsResponse"
},
"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"
+ "$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.",
@@ -280,24 +359,6 @@
},
"id": "CreateServiceAccountRequest"
},
- "ListServiceAccountsResponse": {
- "id": "ListServiceAccountsResponse",
- "description": "The service account list response.",
- "type": "object",
- "properties": {
- "accounts": {
- "description": "The list of matching service accounts.",
- "type": "array",
- "items": {
- "$ref": "ServiceAccount"
- }
- },
- "nextPageToken": {
- "description": "To retrieve the next page of results, set\nListServiceAccountsRequest.page_token\nto this value.",
- "type": "string"
- }
- }
- },
"QueryGrantableRolesResponse": {
"description": "The grantable role query response.",
"type": "object",
@@ -316,25 +377,6 @@
},
"id": "QueryGrantableRolesResponse"
},
- "Role": {
- "description": "A role in the Identity and Access Management API.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the role.\n\nWhen Role is used in CreateRole, the role name must not be set.\n\nWhen Role is used in output and other input such as UpdateRole, the role\nname is the complete path, e.g., roles/logging.viewer for curated roles\nand organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.",
- "type": "string"
- },
- "description": {
- "description": "Optional. A human-readable description for the role.",
- "type": "string"
- },
- "title": {
- "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
- "type": "string"
- }
- },
- "id": "Role"
- },
"SignBlobRequest": {
"description": "The service account sign blob request.",
"type": "object",
@@ -347,8 +389,26 @@
},
"id": "SignBlobRequest"
},
+ "Role": {
+ "properties": {
+ "description": {
+ "description": "Optional. A human-readable description for the role.",
+ "type": "string"
+ },
+ "title": {
+ "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"
+ }
+ },
+ "id": "Role",
+ "description": "A role in the Identity and Access Management API.",
+ "type": "object"
+ },
"SetIamPolicyRequest": {
- "id": "SetIamPolicyRequest",
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
@@ -356,15 +416,15 @@
"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"
},
"Binding": {
- "id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `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",
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"type": "array",
"items": {
"type": "string"
@@ -374,75 +434,14 @@
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
- }
- },
- "QueryGrantableRolesRequest": {
- "description": "The grantable role query request.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional limit on the number of roles to include in the response.",
- "format": "int32",
- "type": "integer"
- },
- "fullResourceName": {
- "description": "Required. The full resource name to query from the list of grantable roles.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
- "type": "string"
- }
},
- "id": "QueryGrantableRolesRequest"
- },
- "ServiceAccount": {
- "id": "ServiceAccount",
- "description": "A service account in the Identity and Access Management API.\n\nTo create a service account, specify the `project_id` and the `account_id`\nfor the account. The `account_id` is unique within the project, and is used\nto generate the service account email address and a stable\n`unique_id`.\n\nIf the account already exists, the account's resource name is returned\nin util::Status's ResourceInfo.resource_name in the format of\nprojects/{PROJECT_ID}/serviceAccounts/{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": {
- "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.",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "@OutputOnly. The OAuth2 client id for the service account.\nThis is used in conjunction with the OAuth2 clientconfig API to make\nthree legged OAuth2 (3LO) flows to access the data of Google users.",
- "type": "string"
- },
- "uniqueId": {
- "description": "@OutputOnly The unique and stable id of the service account.",
- "type": "string"
- },
- "displayName": {
- "description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
- "type": "string"
- },
- "etag": {
- "description": "Used to perform a consistent read-modify-write.",
- "format": "byte",
- "type": "string"
- }
- }
- },
- "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": "Binding"
}
},
"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": "iam",
"auth": {
@@ -466,10 +465,10 @@
"serviceAccounts": {
"methods": {
"delete": {
- "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
@@ -486,11 +485,49 @@
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
- "id": "iam.projects.serviceAccounts.delete",
"path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.delete",
"description": "Deletes a ServiceAccount."
},
+ "list": {
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListServiceAccountsResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Optional limit on the number of service accounts to include in the\nresponse. Further accounts can subsequently be obtained by including the\nListServiceAccountsResponse.next_page_token\nin a subsequent request.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts",
+ "path": "v1/{+name}/serviceAccounts",
+ "id": "iam.projects.serviceAccounts.list",
+ "description": "Lists ServiceAccounts for a project."
+ },
"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"
@@ -514,51 +551,16 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob",
- "path": "v1/{+name}:signBlob",
- "id": "iam.projects.serviceAccounts.signBlob"
- },
- "list": {
- "description": "Lists ServiceAccounts for a project.",
- "response": {
- "$ref": "ListServiceAccountsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional limit on the number of service accounts to include in the\nresponse. Further accounts can subsequently be obtained by including the\nListServiceAccountsResponse.next_page_token\nin a subsequent request.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "path": "v1/{+name}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.list"
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob"
},
"create": {
- "description": "Creates a ServiceAccount\nand returns it.",
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts",
+ "path": "v1/{+name}/serviceAccounts",
+ "id": "iam.projects.serviceAccounts.create",
"request": {
"$ref": "CreateServiceAccountRequest"
},
+ "description": "Creates a ServiceAccount\nand returns it.",
"response": {
"$ref": "ServiceAccount"
},
@@ -566,9 +568,6 @@
"name"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
"description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
@@ -578,22 +577,24 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "path": "v1/{+name}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.create"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"signJwt": {
+ "path": "v1/{+name}:signJwt",
+ "id": "iam.projects.serviceAccounts.signJwt",
"request": {
"$ref": "SignJwtRequest"
},
"description": "Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "SignJwtResponse"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
@@ -606,17 +607,13 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt",
- "id": "iam.projects.serviceAccounts.signJwt",
- "path": "v1/{+name}:signJwt"
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt"
},
"setIamPolicy": {
- "id": "iam.projects.serviceAccounts.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the IAM access control policy for a\nServiceAccount.",
"request": {
"$ref": "SetIamPolicyRequest"
},
- "description": "Sets the IAM access control policy for a\nServiceAccount.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -624,6 +621,9 @@
"response": {
"$ref": "Policy"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
@@ -633,19 +633,19 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy"
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy",
+ "id": "iam.projects.serviceAccounts.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy"
},
"getIamPolicy": {
- "httpMethod": "POST",
+ "description": "Returns 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 requested.\nSee the operation documentation for the appropriate value for this field.",
@@ -659,13 +659,10 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy",
- "id": "iam.projects.serviceAccounts.getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
- "description": "Returns the IAM access control policy for a\nServiceAccount."
+ "id": "iam.projects.serviceAccounts.getIamPolicy"
},
"get": {
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.get",
"description": "Gets a ServiceAccount.",
"response": {
"$ref": "ServiceAccount"
@@ -686,20 +683,22 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}"
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.get"
},
"update": {
"description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.",
"request": {
"$ref": "ServiceAccount"
},
- "response": {
- "$ref": "ServiceAccount"
- },
+ "httpMethod": "PUT",
"parameterOrder": [
"name"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "ServiceAccount"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -713,13 +712,17 @@
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.update"
+ "id": "iam.projects.serviceAccounts.update",
+ "path": "v1/{+name}"
},
"testIamPermissions": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
],
+ "httpMethod": "POST",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
@@ -729,79 +732,25 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"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"
},
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST"
+ "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount."
}
},
"resources": {
"keys": {
"methods": {
- "create": {
- "id": "iam.projects.serviceAccounts.keys.create",
- "path": "v1/{+name}/keys",
- "request": {
- "$ref": "CreateServiceAccountKeyRequest"
- },
- "description": "Creates a ServiceAccountKey\nand returns it.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ServiceAccountKey"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys"
- },
- "delete": {
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.keys.delete",
- "description": "Deletes a ServiceAccountKey."
- },
"list": {
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
+ "id": "iam.projects.serviceAccounts.keys.list",
+ "path": "v1/{+name}/keys",
"description": "Lists ServiceAccountKeys.",
"httpMethod": "GET",
"parameterOrder": [
@@ -811,13 +760,6 @@
"$ref": "ListServiceAccountKeysResponse"
},
"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\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"
- },
"keyTypes": {
"repeated": true,
"location": "query",
@@ -828,18 +770,26 @@
],
"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": {
+ "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\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",
- "id": "iam.projects.serviceAccounts.keys.list",
- "path": "v1/{+name}/keys"
+ ]
},
"get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
+ "parameterOrder": [
+ "name"
],
"parameters": {
"publicKeyType": {
@@ -860,17 +810,66 @@
"type": "string"
}
},
+ "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}",
- "description": "Gets the ServiceAccountKey\nby key id.",
+ "description": "Gets the ServiceAccountKey\nby key id."
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateServiceAccountKeyRequest"
+ },
+ "description": "Creates a ServiceAccountKey\nand returns it.",
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
+ "path": "v1/{+name}/keys",
+ "id": "iam.projects.serviceAccounts.keys.create"
+ },
+ "delete": {
+ "description": "Deletes a ServiceAccountKey.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
"response": {
- "$ref": "ServiceAccountKey"
- }
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
+ "id": "iam.projects.serviceAccounts.keys.delete",
+ "path": "v1/{+name}"
}
}
}
@@ -881,78 +880,73 @@
"roles": {
"methods": {
"queryGrantableRoles": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/roles: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"
},
- "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.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "QueryGrantableRolesResponse"
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/roles:queryGrantableRoles",
+ "id": "iam.roles.queryGrantableRoles",
+ "path": "v1/roles:queryGrantableRoles"
}
}
}
},
"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.",
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
"pp": {
"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"
},
+ "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"
+ "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"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"description": "V1 error format.",
@@ -967,28 +961,37 @@
"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",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
"location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
}
},
"version": "v1",
- "baseUrl": "https://iam.googleapis.com/"
+ "baseUrl": "https://iam.googleapis.com/",
+ "servicePath": "",
+ "description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.",
+ "kind": "discovery#restDescription",
+ "basePath": ""
}
diff --git a/iam/v1/iam-gen.go b/iam/v1/iam-gen.go
index 8f5a1e3..1dcc027 100644
--- a/iam/v1/iam-gen.go
+++ b/iam/v1/iam-gen.go
@@ -180,6 +180,7 @@
// 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
@@ -268,6 +269,8 @@
// CreateServiceAccountKeyRequest: The service account key create
// request.
type CreateServiceAccountKeyRequest struct {
+ IncludePublicKeyData bool `json:"includePublicKeyData,omitempty"`
+
// KeyAlgorithm: Which type of key and algorithm to use for the key.
// The default is currently a 2K RSA key. However this may change in
// the
@@ -292,20 +295,22 @@
// "TYPE_GOOGLE_CREDENTIALS_FILE" - Google Credentials File format.
PrivateKeyType string `json:"privateKeyType,omitempty"`
- // ForceSendFields is a list of field names (e.g. "KeyAlgorithm") 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 is a list of field names (e.g.
+ // "IncludePublicKeyData") 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. "KeyAlgorithm") 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. "IncludePublicKeyData") 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:"-"`
}
diff --git a/kgsearch/v1/kgsearch-api.json b/kgsearch/v1/kgsearch-api.json
index 62a82f3..547ce5a 100644
--- a/kgsearch/v1/kgsearch-api.json
+++ b/kgsearch/v1/kgsearch-api.json
@@ -1,39 +1,39 @@
{
- "discoveryVersion": "v1",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "kgsearch",
+ "batchPath": "batch",
+ "revision": "20170109",
+ "documentationLink": "https://developers.google.com/knowledge-graph/",
+ "id": "kgsearch:v1",
+ "title": "Knowledge Graph Search API",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": "True",
"resources": {
"entities": {
"methods": {
"search": {
- "httpMethod": "GET",
- "parameterOrder": [],
+ "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",
"response": {
"$ref": "SearchResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
- "types": {
- "location": "query",
- "description": "Restricts returned entities with these types, e.g. Person\n(as defined in http://schema.org/Person). If multiple types are specified,\nreturned entities will contain one or more of these types.",
+ "languages": {
+ "description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.",
"type": "string",
- "repeated": true
- },
- "indent": {
- "description": "Enables indenting of json results.",
- "type": "boolean",
+ "repeated": true,
"location": "query"
},
- "languages": {
- "repeated": true,
- "location": "query",
- "description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.",
- "type": "string"
- },
"ids": {
- "type": "string",
- "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"
+ "description": "The list of entity id to be used for search instead of query string.\nTo specify multiple ids in the HTTP request, repeat the parameter in the\nURL as in ...?ids=A&ids=B",
+ "type": "string",
+ "repeated": true
},
"limit": {
"location": "query",
@@ -42,46 +42,33 @@
"type": "integer"
},
"prefix": {
- "description": "Enables prefix match against names and aliases of entities",
"type": "boolean",
- "location": "query"
+ "location": "query",
+ "description": "Enables prefix match against names and aliases of entities"
},
"query": {
"description": "The literal query string for search.",
"type": "string",
"location": "query"
+ },
+ "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": {
+ "description": "Enables indenting of json results.",
+ "type": "boolean",
+ "location": "query"
}
},
- "flatPath": "v1/entities:search",
- "id": "kgsearch.entities.search",
- "path": "v1/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"
+ "flatPath": "v1/entities:search"
}
}
}
},
"parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "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\").",
@@ -93,23 +80,17 @@
"type": "boolean",
"default": "true"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -119,14 +100,15 @@
"1",
"2"
],
- "description": "V1 error format."
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -135,7 +117,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"key": {
"location": "query",
@@ -143,13 +130,35 @@
"type": "string"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "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": {
@@ -168,27 +177,18 @@
"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"
}
},
"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://kgsearch.googleapis.com/",
- "servicePath": "",
- "description": "Searches the Google Knowledge Graph for entities.",
"kind": "discovery#restDescription",
- "rootUrl": "https://kgsearch.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "kgsearch",
- "batchPath": "batch",
- "revision": "20170109",
- "documentationLink": "https://developers.google.com/knowledge-graph/",
- "id": "kgsearch:v1",
- "title": "Knowledge Graph Search API"
+ "description": "Searches the Google Knowledge Graph for entities.",
+ "servicePath": "",
+ "rootUrl": "https://kgsearch.googleapis.com/"
}
diff --git a/language/v1/language-api.json b/language/v1/language-api.json
index 180c83d..dd0b2cc 100644
--- a/language/v1/language-api.json
+++ b/language/v1/language-api.json
@@ -1,131 +1,6 @@
{
- "discoveryVersion": "v1",
- "version_module": "True",
"schemas": {
- "AnalyzeSyntaxRequest": {
- "description": "The syntax 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": "AnalyzeSyntaxRequest"
- },
- "AnalyzeSentimentResponse": {
- "description": "The sentiment analysis response message.",
- "type": "object",
- "properties": {
- "documentSentiment": {
- "description": "The overall sentiment of the input document.",
- "$ref": "Sentiment"
- },
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "type": "array",
- "items": {
- "$ref": "Sentence"
- }
- }
- },
- "id": "AnalyzeSentimentResponse"
- },
- "AnalyzeEntitiesResponse": {
- "description": "The entity analysis response message.",
- "type": "object",
- "properties": {
- "entities": {
- "description": "The recognized entities in the input document.",
- "type": "array",
- "items": {
- "$ref": "Entity"
- }
- },
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- }
- },
- "id": "AnalyzeEntitiesResponse"
- },
- "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"
- },
"AnalyzeSyntaxResponse": {
- "description": "The syntax analysis response message.",
- "type": "object",
"properties": {
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
@@ -146,13 +21,73 @@
}
}
},
- "id": "AnalyzeSyntaxResponse"
+ "id": "AnalyzeSyntaxResponse",
+ "description": "The syntax analysis response message.",
+ "type": "object"
},
- "AnnotateTextRequest": {
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "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"
+ },
+ "AnnotateTextRequest": {
+ "properties": {
"encodingType": {
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
"description": "The encoding type used by the API to calculate offsets.",
"type": "string",
"enumDescriptions": [
@@ -160,29 +95,40 @@
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
]
},
"document": {
- "$ref": "Document",
- "description": "Input document."
+ "description": "Input document.",
+ "$ref": "Document"
},
"features": {
- "$ref": "Features",
- "description": "The enabled features."
+ "description": "The enabled features.",
+ "$ref": "Features"
}
},
- "id": "AnnotateTextRequest"
+ "id": "AnnotateTextRequest",
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "type": "object"
},
"AnnotateTextResponse": {
"description": "The text annotations response message.",
"type": "object",
"properties": {
+ "entities": {
+ "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
+ "type": "array",
+ "items": {
+ "$ref": "Entity"
+ }
+ },
+ "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",
@@ -196,21 +142,6 @@
"items": {
"$ref": "Token"
}
- },
- "entities": {
- "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
- "type": "array",
- "items": {
- "$ref": "Entity"
- }
- },
- "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"
@@ -219,13 +150,7 @@
"description": "The sentiment analysis request message.",
"type": "object",
"properties": {
- "document": {
- "description": "Input document.",
- "$ref": "Document"
- },
"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.",
@@ -237,7 +162,13 @@
"UTF8",
"UTF16",
"UTF32"
- ]
+ ],
+ "description": "The encoding type used by the API to calculate sentence offsets.",
+ "type": "string"
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
}
},
"id": "AnalyzeSentimentRequest"
@@ -246,91 +177,7 @@
"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": {
- "enumDescriptions": [
- "Unknown",
- "Abbreviation modifier",
- "Adjectival complement",
- "Adverbial clause modifier",
- "Adverbial modifier",
- "Adjectival modifier of an NP",
- "Appositional modifier of an NP",
- "Attribute dependent of a copular verb",
- "Auxiliary (non-main) verb",
- "Passive auxiliary",
- "Coordinating conjunction",
- "Clausal complement of a verb or adjective",
- "Conjunct",
- "Clausal subject",
- "Clausal passive subject",
- "Dependency (unable to determine)",
- "Determiner",
- "Discourse",
- "Direct object",
- "Expletive",
- "Goes with (part of a word in a text not well edited)",
- "Indirect object",
- "Marker (word introducing a subordinate clause)",
- "Multi-word expression",
- "Multi-word verbal expression",
- "Negation modifier",
- "Noun compound modifier",
- "Noun phrase used as an adverbial modifier",
- "Nominal subject",
- "Passive nominal subject",
- "Numeric modifier of a noun",
- "Element of compound number",
- "Punctuation mark",
- "Parataxis relation",
- "Participial modifier",
- "The complement of a preposition is a clause",
- "Object of a preposition",
- "Possession modifier",
- "Postverbal negative particle",
- "Predicate complement",
- "Preconjunt",
- "Predeterminer",
- "Prefix",
- "Prepositional modifier",
- "The relationship between a verb and verbal morpheme",
- "Particle",
- "Associative or possessive marker",
- "Quantifier phrase modifier",
- "Relative clause modifier",
- "Complementizer in relative clause",
- "Ellipsis without a preceding predicate",
- "Referent",
- "Remnant",
- "Reparandum",
- "Root",
- "Suffix specifying a unit of number",
- "Suffix",
- "Temporal modifier",
- "Topic marker",
- "Clause headed by an infinite form of the verb that modifies a noun",
- "Vocative",
- "Open clausal complement",
- "Name suffix",
- "Name title",
- "Adverbial phrase modifier",
- "Causative auxiliary",
- "Helper auxiliary",
- "Rentaishi (Prenominal modifier)",
- "Foreign words",
- "Keyword",
- "List for chains of comparable items",
- "Nominalized clause",
- "Nominalized clausal subject",
- "Nominalized clausal passive",
- "Compound of numeric modifier",
- "Copula",
- "Dislocated relation (for fronted/topicalized elements)"
- ],
"enum": [
"UNKNOWN",
"ABBREV",
@@ -411,37 +258,96 @@
"DISLOCATED"
],
"description": "The parse label for the token.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Abbreviation modifier",
+ "Adjectival complement",
+ "Adverbial clause modifier",
+ "Adverbial modifier",
+ "Adjectival modifier of an NP",
+ "Appositional modifier of an NP",
+ "Attribute dependent of a copular verb",
+ "Auxiliary (non-main) verb",
+ "Passive auxiliary",
+ "Coordinating conjunction",
+ "Clausal complement of a verb or adjective",
+ "Conjunct",
+ "Clausal subject",
+ "Clausal passive subject",
+ "Dependency (unable to determine)",
+ "Determiner",
+ "Discourse",
+ "Direct object",
+ "Expletive",
+ "Goes with (part of a word in a text not well edited)",
+ "Indirect object",
+ "Marker (word introducing a subordinate clause)",
+ "Multi-word expression",
+ "Multi-word verbal expression",
+ "Negation modifier",
+ "Noun compound modifier",
+ "Noun phrase used as an adverbial modifier",
+ "Nominal subject",
+ "Passive nominal subject",
+ "Numeric modifier of a noun",
+ "Element of compound number",
+ "Punctuation mark",
+ "Parataxis relation",
+ "Participial modifier",
+ "The complement of a preposition is a clause",
+ "Object of a preposition",
+ "Possession modifier",
+ "Postverbal negative particle",
+ "Predicate complement",
+ "Preconjunt",
+ "Predeterminer",
+ "Prefix",
+ "Prepositional modifier",
+ "The relationship between a verb and verbal morpheme",
+ "Particle",
+ "Associative or possessive marker",
+ "Quantifier phrase modifier",
+ "Relative clause modifier",
+ "Complementizer in relative clause",
+ "Ellipsis without a preceding predicate",
+ "Referent",
+ "Remnant",
+ "Reparandum",
+ "Root",
+ "Suffix specifying a unit of number",
+ "Suffix",
+ "Temporal modifier",
+ "Topic marker",
+ "Clause headed by an infinite form of the verb that modifies a noun",
+ "Vocative",
+ "Open clausal complement",
+ "Name suffix",
+ "Name title",
+ "Adverbial phrase modifier",
+ "Causative auxiliary",
+ "Helper auxiliary",
+ "Rentaishi (Prenominal modifier)",
+ "Foreign words",
+ "Keyword",
+ "List for chains of comparable items",
+ "Nominalized clause",
+ "Nominalized clausal subject",
+ "Nominalized clausal passive",
+ "Compound of numeric modifier",
+ "Copula",
+ "Dislocated relation (for fronted/topicalized elements)"
+ ]
+ },
+ "headTokenIndex": {
+ "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "DependencyEdge"
},
- "Token": {
- "description": "Represents the smallest syntactic building block of the text.",
- "type": "object",
- "properties": {
- "text": {
- "description": "The token text.",
- "$ref": "TextSpan"
- },
- "dependencyEdge": {
- "description": "Dependency tree parse for this token.",
- "$ref": "DependencyEdge"
- },
- "lemma": {
- "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
- "type": "string"
- },
- "partOfSpeech": {
- "description": "Parts of speech tag for this token.",
- "$ref": "PartOfSpeech"
- }
- },
- "id": "Token"
- },
"TextSpan": {
- "description": "Represents an output piece of text.",
- "type": "object",
"properties": {
"beginOffset": {
"description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
@@ -453,21 +359,35 @@
"type": "string"
}
},
- "id": "TextSpan"
+ "id": "TextSpan",
+ "description": "Represents an output piece of text.",
+ "type": "object"
},
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` 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.",
+ "Token": {
+ "description": "Represents the smallest syntactic building block of the text.",
"type": "object",
"properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
+ "partOfSpeech": {
+ "$ref": "PartOfSpeech",
+ "description": "Parts of speech tag for this token."
},
- "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.",
+ "text": {
+ "$ref": "TextSpan",
+ "description": "The token text."
+ },
+ "dependencyEdge": {
+ "$ref": "DependencyEdge",
+ "description": "Dependency tree parse for this token."
+ },
+ "lemma": {
+ "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
"type": "string"
- },
+ }
+ },
+ "id": "Token"
+ },
+ "Status": {
+ "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",
@@ -478,31 +398,42 @@
},
"type": "object"
}
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
- "id": "Status"
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
},
"EntityMention": {
"description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
"type": "object",
"properties": {
"text": {
- "$ref": "TextSpan",
- "description": "The mention text."
+ "description": "The mention text.",
+ "$ref": "TextSpan"
},
"type": {
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ],
"enum": [
"TYPE_UNKNOWN",
"PROPER",
"COMMON"
],
"description": "The type of the entity mention.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Proper name",
+ "Common noun (or noun compound)"
+ ]
}
},
"id": "EntityMention"
@@ -530,19 +461,23 @@
"description": "################################################################ #\n\nRepresents the input to API methods.",
"type": "object",
"properties": {
+ "language": {
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
+ "type": "string"
+ },
"type": {
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
- ],
"enum": [
"TYPE_UNSPECIFIED",
"PLAIN_TEXT",
"HTML"
],
"description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The content type is not specified.",
+ "Plain text",
+ "HTML"
+ ]
},
"content": {
"description": "The content of the input in string format.",
@@ -551,10 +486,6 @@
"gcsContentUri": {
"description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
"type": "string"
- },
- "language": {
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](https://cloud.google.com/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
- "type": "string"
}
},
"id": "Document"
@@ -605,13 +536,13 @@
"description": "Represents the feeling associated with the entire text or entities in\nthe text.",
"type": "object",
"properties": {
- "score": {
- "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
+ "magnitude": {
+ "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
"format": "float",
"type": "number"
},
- "magnitude": {
- "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
+ "score": {
+ "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
"format": "float",
"type": "number"
}
@@ -619,116 +550,22 @@
"id": "Sentiment"
},
"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": {
- "person": {
- "description": "The grammatical person.",
- "type": "string",
- "enumDescriptions": [
- "Person is not applicable in the analyzed language or is not predicted.",
- "First",
- "Second",
- "Third",
- "Reflexive"
- ],
- "enum": [
- "PERSON_UNKNOWN",
- "FIRST",
- "SECOND",
- "THIRD",
- "REFLEXIVE_PERSON"
- ]
- },
- "proper": {
- "enumDescriptions": [
- "Proper is not applicable in the analyzed language or is not predicted.",
- "Proper",
- "Not proper"
- ],
- "enum": [
- "PROPER_UNKNOWN",
- "PROPER",
- "NOT_PROPER"
- ],
- "description": "The grammatical properness.",
- "type": "string"
- },
- "case": {
- "enumDescriptions": [
- "Case is not applicable in the analyzed language or is not predicted.",
- "Accusative",
- "Adverbial",
- "Complementive",
- "Dative",
- "Genitive",
- "Instrumental",
- "Locative",
- "Nominative",
- "Oblique",
- "Partitive",
- "Prepositional",
- "Reflexive",
- "Relative",
- "Vocative"
- ],
- "enum": [
- "CASE_UNKNOWN",
- "ACCUSATIVE",
- "ADVERBIAL",
- "COMPLEMENTIVE",
- "DATIVE",
- "GENITIVE",
- "INSTRUMENTAL",
- "LOCATIVE",
- "NOMINATIVE",
- "OBLIQUE",
- "PARTITIVE",
- "PREPOSITIONAL",
- "REFLEXIVE_CASE",
- "RELATIVE_CASE",
- "VOCATIVE"
- ],
- "description": "The grammatical case.",
- "type": "string"
- },
- "tense": {
- "enumDescriptions": [
- "Tense is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Future",
- "Past",
- "Present",
- "Imperfect",
- "Pluperfect"
- ],
- "enum": [
- "TENSE_UNKNOWN",
- "CONDITIONAL_TENSE",
- "FUTURE",
- "PAST",
- "PRESENT",
- "IMPERFECT",
- "PLUPERFECT"
- ],
- "description": "The grammatical tense.",
- "type": "string"
- },
- "reciprocity": {
- "description": "The grammatical reciprocity.",
- "type": "string",
- "enumDescriptions": [
- "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
- "Reciprocal",
- "Non-reciprocal"
- ],
- "enum": [
- "RECIPROCITY_UNKNOWN",
- "RECIPROCAL",
- "NON_RECIPROCAL"
- ]
- },
"form": {
+ "enum": [
+ "FORM_UNKNOWN",
+ "ADNOMIAL",
+ "AUXILIARY",
+ "COMPLEMENTIZER",
+ "FINAL_ENDING",
+ "GERUND",
+ "REALIS",
+ "IRREALIS",
+ "SHORT",
+ "LONG",
+ "ORDER",
+ "SPECIFIC"
+ ],
"description": "The grammatical form.",
"type": "string",
"enumDescriptions": [
@@ -744,25 +581,9 @@
"Long form",
"Order form",
"Specific form"
- ],
- "enum": [
- "FORM_UNKNOWN",
- "ADNOMIAL",
- "AUXILIARY",
- "COMPLEMENTIZER",
- "FINAL_ENDING",
- "GERUND",
- "REALIS",
- "IRREALIS",
- "SHORT",
- "LONG",
- "ORDER",
- "SPECIFIC"
]
},
"number": {
- "description": "The grammatical number.",
- "type": "string",
"enumDescriptions": [
"Number is not applicable in the analyzed language or is not predicted.",
"Singular",
@@ -774,7 +595,9 @@
"SINGULAR",
"PLURAL",
"DUAL"
- ]
+ ],
+ "description": "The grammatical number.",
+ "type": "string"
},
"voice": {
"enumDescriptions": [
@@ -793,6 +616,12 @@
"type": "string"
},
"aspect": {
+ "enum": [
+ "ASPECT_UNKNOWN",
+ "PERFECTIVE",
+ "IMPERFECTIVE",
+ "PROGRESSIVE"
+ ],
"description": "The grammatical aspect.",
"type": "string",
"enumDescriptions": [
@@ -800,12 +629,6 @@
"Perfective",
"Imperfective",
"Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
]
},
"mood": {
@@ -831,8 +654,6 @@
"type": "string"
},
"tag": {
- "description": "The part of speech tag.",
- "type": "string",
"enumDescriptions": [
"Unknown",
"Adjective",
@@ -864,9 +685,17 @@
"VERB",
"X",
"AFFIX"
- ]
+ ],
+ "description": "The part of speech tag.",
+ "type": "string"
},
"gender": {
+ "enum": [
+ "GENDER_UNKNOWN",
+ "FEMININE",
+ "MASCULINE",
+ "NEUTER"
+ ],
"description": "The grammatical gender.",
"type": "string",
"enumDescriptions": [
@@ -874,23 +703,192 @@
"Feminine",
"Masculine",
"Neuter"
+ ]
+ },
+ "person": {
+ "enum": [
+ "PERSON_UNKNOWN",
+ "FIRST",
+ "SECOND",
+ "THIRD",
+ "REFLEXIVE_PERSON"
+ ],
+ "description": "The grammatical person.",
+ "type": "string",
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ]
+ },
+ "proper": {
+ "enum": [
+ "PROPER_UNKNOWN",
+ "PROPER",
+ "NOT_PROPER"
+ ],
+ "description": "The grammatical properness.",
+ "type": "string",
+ "enumDescriptions": [
+ "Proper is not applicable in the analyzed language or is not predicted.",
+ "Proper",
+ "Not proper"
+ ]
+ },
+ "case": {
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
+ ],
+ "description": "The grammatical case.",
+ "type": "string",
+ "enumDescriptions": [
+ "Case is not applicable in the analyzed language or is not predicted.",
+ "Accusative",
+ "Adverbial",
+ "Complementive",
+ "Dative",
+ "Genitive",
+ "Instrumental",
+ "Locative",
+ "Nominative",
+ "Oblique",
+ "Partitive",
+ "Prepositional",
+ "Reflexive",
+ "Relative",
+ "Vocative"
+ ]
+ },
+ "tense": {
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "FUTURE",
+ "PAST",
+ "PRESENT",
+ "IMPERFECT",
+ "PLUPERFECT"
+ ],
+ "description": "The grammatical tense.",
+ "type": "string",
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ]
+ },
+ "reciprocity": {
+ "enumDescriptions": [
+ "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
+ "Reciprocal",
+ "Non-reciprocal"
],
"enum": [
- "GENDER_UNKNOWN",
- "FEMININE",
- "MASCULINE",
- "NEUTER"
- ]
+ "RECIPROCITY_UNKNOWN",
+ "RECIPROCAL",
+ "NON_RECIPROCAL"
+ ],
+ "description": "The grammatical reciprocity.",
+ "type": "string"
}
},
- "id": "PartOfSpeech"
+ "id": "PartOfSpeech",
+ "description": "Represents part of speech information for a token. Parts of speech\nare as defined in\nhttp://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf",
+ "type": "object"
+ },
+ "AnalyzeSyntaxRequest": {
+ "description": "The syntax analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string"
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeSyntaxRequest"
+ },
+ "AnalyzeSentimentResponse": {
+ "properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "sentences": {
+ "description": "The sentiment for all the sentences in the document.",
+ "type": "array",
+ "items": {
+ "$ref": "Sentence"
+ }
+ },
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment of the input document."
+ }
+ },
+ "id": "AnalyzeSentimentResponse",
+ "description": "The sentiment analysis response message.",
+ "type": "object"
+ },
+ "AnalyzeEntitiesResponse": {
+ "properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "entities": {
+ "description": "The recognized entities in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "Entity"
+ }
+ }
+ },
+ "id": "AnalyzeEntitiesResponse",
+ "description": "The entity analysis response message.",
+ "type": "object"
}
},
- "icons": {
- "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": {
@@ -910,113 +908,92 @@
"resources": {
"documents": {
"methods": {
- "analyzeSyntax": {
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
- "request": {
- "$ref": "AnalyzeSyntaxRequest"
+ "analyzeEntities": {
+ "response": {
+ "$ref": "AnalyzeEntitiesResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/documents:analyzeEntities",
+ "path": "v1/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities",
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ }
+ },
+ "analyzeSyntax": {
"response": {
"$ref": "AnalyzeSyntaxResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {},
"flatPath": "v1/documents:analyzeSyntax",
"path": "v1/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax"
+ "id": "language.documents.analyzeSyntax",
+ "request": {
+ "$ref": "AnalyzeSyntaxRequest"
+ },
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties."
},
"analyzeSentiment": {
- "description": "Analyzes the sentiment of the provided text.",
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- },
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "AnalyzeSentimentResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
"flatPath": "v1/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
"path": "v1/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment"
+ "description": "Analyzes the sentiment of the provided text.",
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ }
},
"annotateText": {
- "httpMethod": "POST",
- "parameterOrder": [],
+ "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ },
"response": {
"$ref": "AnnotateTextResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
"flatPath": "v1/documents:annotateText",
- "id": "language.documents.annotateText",
"path": "v1/documents:annotateText",
- "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
- "request": {
- "$ref": "AnnotateTextRequest"
- }
- },
- "analyzeEntities": {
- "flatPath": "v1/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities",
- "path": "v1/documents:analyzeEntities",
- "request": {
- "$ref": "AnalyzeEntitiesRequest"
- },
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeEntitiesResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "id": "language.documents.annotateText"
}
}
}
},
"parameters": {
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
+ "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",
@@ -1028,35 +1005,40 @@
"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"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -1065,21 +1047,39 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
}
},
"version": "v1",
"baseUrl": "https://language.googleapis.com/",
- "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": "",
+ "kind": "discovery#restDescription",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
"basePath": "",
- "revision": "20170502",
+ "documentationLink": "https://cloud.google.com/natural-language/",
+ "revision": "20170525",
"id": "language:v1",
- "documentationLink": "https://cloud.google.com/natural-language/"
+ "discoveryVersion": "v1",
+ "version_module": "True"
}
diff --git a/language/v1/language-gen.go b/language/v1/language-gen.go
index 9ae8b80..74134bb 100644
--- a/language/v1/language-gen.go
+++ b/language/v1/language-gen.go
@@ -629,10 +629,8 @@
// automatically detected). Both ISO and BCP-47 language codes
// are
// accepted.<br>
- // [Language
- // Support](https://cloud.google.com/natural-language/docs/languages)
- // lis
- // ts currently supported languages for each API method.
+ // [Language Support](/natural-language/docs/languages)
+ // lists currently supported languages for each API method.
// If the language (either specified by the caller or automatically
// detected)
// is not supported by the called API method, an `INVALID_ARGUMENT`
@@ -1135,7 +1133,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -1168,7 +1166,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
diff --git a/language/v1beta1/language-api.json b/language/v1beta1/language-api.json
index 74735c2..35c09dd 100644
--- a/language/v1beta1/language-api.json
+++ b/language/v1beta1/language-api.json
@@ -8,22 +8,40 @@
"resources": {
"documents": {
"methods": {
- "analyzeSentiment": {
- "id": "language.documents.analyzeSentiment",
- "path": "v1beta1/documents:analyzeSentiment",
- "description": "Analyzes the sentiment of the provided text.",
+ "analyzeSyntax": {
+ "flatPath": "v1beta1/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "path": "v1beta1/documents:analyzeSyntax",
"request": {
- "$ref": "AnalyzeSentimentRequest"
+ "$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": {
+ "path": "v1beta1/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ },
+ "description": "Analyzes the sentiment of the provided text.",
+ "response": {
"$ref": "AnalyzeSentimentResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {},
"flatPath": "v1beta1/documents:analyzeSentiment"
},
"annotateText": {
@@ -32,83 +50,55 @@
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"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"
- },
- "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call."
+ }
},
"analyzeEntities": {
- "httpMethod": "POST",
- "parameterOrder": [],
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
"response": {
"$ref": "AnalyzeEntitiesResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
"flatPath": "v1beta1/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities",
"path": "v1beta1/documents:analyzeEntities",
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
- "request": {
- "$ref": "AnalyzeEntitiesRequest"
- }
- },
- "analyzeSyntax": {
- "response": {
- "$ref": "AnalyzeSyntaxResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/documents:analyzeSyntax",
- "path": "v1beta1/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax",
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
- "request": {
- "$ref": "AnalyzeSyntaxRequest"
- }
+ "id": "language.documents.analyzeEntities"
}
}
}
},
"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": {
+ "quotaUser": {
"location": "query",
- "description": "OAuth access token.",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
"pp": {
- "description": "Pretty-print response.",
"type": "boolean",
"default": "true",
- "location": "query"
+ "location": "query",
+ "description": "Pretty-print response."
},
"bearer_token": {
- "description": "OAuth bearer token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth bearer token."
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
@@ -116,9 +106,9 @@
"location": "query"
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -126,35 +116,36 @@
"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"
},
+ "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": {
+ "default": "json",
"enum": [
"json",
"media",
@@ -167,22 +158,414 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "description": "Data format for response."
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
}
},
"version": "v1beta1",
"baseUrl": "https://language.googleapis.com/",
- "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",
"servicePath": "",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "id": "language:v1beta1",
- "revision": "20170502",
+ "revision": "20170525",
"documentationLink": "https://cloud.google.com/natural-language/",
+ "id": "language:v1beta1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "Sentiment": {
+ "properties": {
+ "polarity": {
+ "description": "DEPRECATED FIELD - This field is being deprecated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.google.com/natural-language/docs for more information.",
+ "format": "float",
+ "type": "number"
+ },
+ "score": {
+ "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
+ "format": "float",
+ "type": "number"
+ },
+ "magnitude": {
+ "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "Sentiment",
+ "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
+ "type": "object"
+ },
+ "AnalyzeEntitiesRequest": {
+ "description": "The entity analysis request message.",
+ "type": "object",
+ "properties": {
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ },
+ "encodingType": {
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ]
+ }
+ },
+ "id": "AnalyzeEntitiesRequest"
+ },
+ "PartOfSpeech": {
+ "description": "Represents part of speech information for a token.",
+ "type": "object",
+ "properties": {
+ "person": {
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ],
+ "enum": [
+ "PERSON_UNKNOWN",
+ "FIRST",
+ "SECOND",
+ "THIRD",
+ "REFLEXIVE_PERSON"
+ ],
+ "description": "The grammatical person.",
+ "type": "string"
+ },
+ "proper": {
+ "type": "string",
+ "enumDescriptions": [
+ "Proper is not applicable in the analyzed language or is not predicted.",
+ "Proper",
+ "Not proper"
+ ],
+ "enum": [
+ "PROPER_UNKNOWN",
+ "PROPER",
+ "NOT_PROPER"
+ ],
+ "description": "The grammatical properness."
+ },
+ "case": {
+ "type": "string",
+ "enumDescriptions": [
+ "Case is not applicable in the analyzed language or is not predicted.",
+ "Accusative",
+ "Adverbial",
+ "Complementive",
+ "Dative",
+ "Genitive",
+ "Instrumental",
+ "Locative",
+ "Nominative",
+ "Oblique",
+ "Partitive",
+ "Prepositional",
+ "Reflexive",
+ "Relative",
+ "Vocative"
+ ],
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
+ ],
+ "description": "The grammatical case."
+ },
+ "tense": {
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "FUTURE",
+ "PAST",
+ "PRESENT",
+ "IMPERFECT",
+ "PLUPERFECT"
+ ],
+ "description": "The grammatical tense.",
+ "type": "string",
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ]
+ },
+ "reciprocity": {
+ "type": "string",
+ "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."
+ },
+ "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": {
+ "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": {
+ "enum": [
+ "ASPECT_UNKNOWN",
+ "PERFECTIVE",
+ "IMPERFECTIVE",
+ "PROGRESSIVE"
+ ],
+ "description": "The grammatical aspect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Aspect is not applicable in the analyzed language or is not predicted.",
+ "Perfective",
+ "Imperfective",
+ "Progressive"
+ ]
+ },
+ "mood": {
+ "enumDescriptions": [
+ "Mood is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Imperative",
+ "Indicative",
+ "Interrogative",
+ "Jussive",
+ "Subjunctive"
+ ],
+ "enum": [
+ "MOOD_UNKNOWN",
+ "CONDITIONAL_MOOD",
+ "IMPERATIVE",
+ "INDICATIVE",
+ "INTERROGATIVE",
+ "JUSSIVE",
+ "SUBJUNCTIVE"
+ ],
+ "description": "The grammatical mood.",
+ "type": "string"
+ },
+ "tag": {
+ "enumDescriptions": [
+ "Unknown",
+ "Adjective",
+ "Adposition (preposition and postposition)",
+ "Adverb",
+ "Conjunction",
+ "Determiner",
+ "Noun (common and proper)",
+ "Cardinal number",
+ "Pronoun",
+ "Particle or other function word",
+ "Punctuation",
+ "Verb (all tenses and modes)",
+ "Other: foreign words, typos, abbreviations",
+ "Affix"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ],
+ "description": "The part of speech tag.",
+ "type": "string"
+ },
+ "gender": {
+ "enumDescriptions": [
+ "Gender is not applicable in the analyzed language or is not predicted.",
+ "Feminine",
+ "Masculine",
+ "Neuter"
+ ],
+ "enum": [
+ "GENDER_UNKNOWN",
+ "FEMININE",
+ "MASCULINE",
+ "NEUTER"
+ ],
+ "description": "The grammatical gender.",
+ "type": "string"
+ }
+ },
+ "id": "PartOfSpeech"
+ },
+ "AnalyzeSyntaxRequest": {
+ "description": "The syntax analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ]
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeSyntaxRequest"
+ },
+ "AnalyzeSentimentResponse": {
+ "description": "The sentiment analysis response message.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "type": "string",
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details."
+ }
+ },
+ "id": "AnalyzeSentimentResponse"
+ },
+ "AnalyzeEntitiesResponse": {
+ "description": "The entity analysis response message.",
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "entities": {
+ "description": "The recognized entities in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "Entity"
+ }
+ }
+ },
+ "id": "AnalyzeEntitiesResponse"
+ },
"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",
@@ -199,6 +582,16 @@
"type": "string"
},
"type": {
+ "enumDescriptions": [
+ "Unknown",
+ "Person",
+ "Location",
+ "Organization",
+ "Event",
+ "Work of art",
+ "Consumer goods",
+ "Other types"
+ ],
"enum": [
"UNKNOWN",
"PERSON",
@@ -210,17 +603,7 @@
"OTHER"
],
"description": "The entity type.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ]
+ "type": "string"
},
"metadata": {
"additionalProperties": {
@@ -238,6 +621,8 @@
"id": "Entity"
},
"AnalyzeSyntaxResponse": {
+ "description": "The syntax analysis response message.",
+ "type": "object",
"properties": {
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
@@ -251,22 +636,30 @@
}
},
"tokens": {
- "description": "Tokens, along with their syntactic information, in the input document.",
"type": "array",
"items": {
"$ref": "Token"
- }
+ },
+ "description": "Tokens, along with their syntactic information, in the input document."
}
},
- "id": "AnalyzeSyntaxResponse",
- "description": "The syntax analysis response message.",
- "type": "object"
+ "id": "AnalyzeSyntaxResponse"
},
"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`.",
"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.",
@@ -278,21 +671,47 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- },
- "features": {
- "$ref": "Features",
- "description": "The enabled features."
+ ]
}
},
"id": "AnnotateTextRequest"
},
+ "AnnotateTextResponse": {
+ "id": "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."
+ },
+ "sentences": {
+ "description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
+ "type": "array",
+ "items": {
+ "$ref": "Sentence"
+ }
+ },
+ "tokens": {
+ "type": "array",
+ "items": {
+ "$ref": "Token"
+ },
+ "description": "Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax."
+ },
+ "entities": {
+ "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
+ "type": "array",
+ "items": {
+ "$ref": "Entity"
+ }
+ }
+ }
+ },
"AnalyzeSentimentRequest": {
"description": "The sentiment analysis request message.",
"type": "object",
@@ -320,131 +739,11 @@
},
"id": "AnalyzeSentimentRequest"
},
- "AnnotateTextResponse": {
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
- "type": "array",
- "items": {
- "$ref": "Sentence"
- }
- },
- "tokens": {
- "description": "Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
- "type": "array",
- "items": {
- "$ref": "Token"
- }
- },
- "entities": {
- "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
- "type": "array",
- "items": {
- "$ref": "Entity"
- }
- },
- "documentSentiment": {
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.",
- "$ref": "Sentiment"
- }
- },
- "id": "AnnotateTextResponse",
- "description": "The text annotations response message.",
- "type": "object"
- },
"DependencyEdge": {
"description": "Represents dependency parse tree information for a token.",
"type": "object",
"properties": {
- "headTokenIndex": {
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
- "format": "int32",
- "type": "integer"
- },
"label": {
- "enumDescriptions": [
- "Unknown",
- "Abbreviation modifier",
- "Adjectival complement",
- "Adverbial clause modifier",
- "Adverbial modifier",
- "Adjectival modifier of an NP",
- "Appositional modifier of an NP",
- "Attribute dependent of a copular verb",
- "Auxiliary (non-main) verb",
- "Passive auxiliary",
- "Coordinating conjunction",
- "Clausal complement of a verb or adjective",
- "Conjunct",
- "Clausal subject",
- "Clausal passive subject",
- "Dependency (unable to determine)",
- "Determiner",
- "Discourse",
- "Direct object",
- "Expletive",
- "Goes with (part of a word in a text not well edited)",
- "Indirect object",
- "Marker (word introducing a subordinate clause)",
- "Multi-word expression",
- "Multi-word verbal expression",
- "Negation modifier",
- "Noun compound modifier",
- "Noun phrase used as an adverbial modifier",
- "Nominal subject",
- "Passive nominal subject",
- "Numeric modifier of a noun",
- "Element of compound number",
- "Punctuation mark",
- "Parataxis relation",
- "Participial modifier",
- "The complement of a preposition is a clause",
- "Object of a preposition",
- "Possession modifier",
- "Postverbal negative particle",
- "Predicate complement",
- "Preconjunt",
- "Predeterminer",
- "Prefix",
- "Prepositional modifier",
- "The relationship between a verb and verbal morpheme",
- "Particle",
- "Associative or possessive marker",
- "Quantifier phrase modifier",
- "Relative clause modifier",
- "Complementizer in relative clause",
- "Ellipsis without a preceding predicate",
- "Referent",
- "Remnant",
- "Reparandum",
- "Root",
- "Suffix specifying a unit of number",
- "Suffix",
- "Temporal modifier",
- "Topic marker",
- "Clause headed by an infinite form of the verb that modifies a noun",
- "Vocative",
- "Open clausal complement",
- "Name suffix",
- "Name title",
- "Adverbial phrase modifier",
- "Causative auxiliary",
- "Helper auxiliary",
- "Rentaishi (Prenominal modifier)",
- "Foreign words",
- "Keyword",
- "List for chains of comparable items",
- "Nominalized clause",
- "Nominalized clausal subject",
- "Nominalized clausal passive",
- "Compound of numeric modifier",
- "Copula",
- "Dislocated relation (for fronted/topicalized elements)"
- ],
"enum": [
"UNKNOWN",
"ABBREV",
@@ -525,34 +824,95 @@
"DISLOCATED"
],
"description": "The parse label for the token.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Abbreviation modifier",
+ "Adjectival complement",
+ "Adverbial clause modifier",
+ "Adverbial modifier",
+ "Adjectival modifier of an NP",
+ "Appositional modifier of an NP",
+ "Attribute dependent of a copular verb",
+ "Auxiliary (non-main) verb",
+ "Passive auxiliary",
+ "Coordinating conjunction",
+ "Clausal complement of a verb or adjective",
+ "Conjunct",
+ "Clausal subject",
+ "Clausal passive subject",
+ "Dependency (unable to determine)",
+ "Determiner",
+ "Discourse",
+ "Direct object",
+ "Expletive",
+ "Goes with (part of a word in a text not well edited)",
+ "Indirect object",
+ "Marker (word introducing a subordinate clause)",
+ "Multi-word expression",
+ "Multi-word verbal expression",
+ "Negation modifier",
+ "Noun compound modifier",
+ "Noun phrase used as an adverbial modifier",
+ "Nominal subject",
+ "Passive nominal subject",
+ "Numeric modifier of a noun",
+ "Element of compound number",
+ "Punctuation mark",
+ "Parataxis relation",
+ "Participial modifier",
+ "The complement of a preposition is a clause",
+ "Object of a preposition",
+ "Possession modifier",
+ "Postverbal negative particle",
+ "Predicate complement",
+ "Preconjunt",
+ "Predeterminer",
+ "Prefix",
+ "Prepositional modifier",
+ "The relationship between a verb and verbal morpheme",
+ "Particle",
+ "Associative or possessive marker",
+ "Quantifier phrase modifier",
+ "Relative clause modifier",
+ "Complementizer in relative clause",
+ "Ellipsis without a preceding predicate",
+ "Referent",
+ "Remnant",
+ "Reparandum",
+ "Root",
+ "Suffix specifying a unit of number",
+ "Suffix",
+ "Temporal modifier",
+ "Topic marker",
+ "Clause headed by an infinite form of the verb that modifies a noun",
+ "Vocative",
+ "Open clausal complement",
+ "Name suffix",
+ "Name title",
+ "Adverbial phrase modifier",
+ "Causative auxiliary",
+ "Helper auxiliary",
+ "Rentaishi (Prenominal modifier)",
+ "Foreign words",
+ "Keyword",
+ "List for chains of comparable items",
+ "Nominalized clause",
+ "Nominalized clausal subject",
+ "Nominalized clausal passive",
+ "Compound of numeric modifier",
+ "Copula",
+ "Dislocated relation (for fronted/topicalized elements)"
+ ]
+ },
+ "headTokenIndex": {
+ "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "DependencyEdge"
},
- "Token": {
- "description": "Represents the smallest syntactic building block of the text.",
- "type": "object",
- "properties": {
- "lemma": {
- "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
- "type": "string"
- },
- "partOfSpeech": {
- "$ref": "PartOfSpeech",
- "description": "Parts of speech tag for this token."
- },
- "text": {
- "$ref": "TextSpan",
- "description": "The token text."
- },
- "dependencyEdge": {
- "description": "Dependency tree parse for this token.",
- "$ref": "DependencyEdge"
- }
- },
- "id": "Token"
- },
"TextSpan": {
"description": "Represents an output piece of text.",
"type": "object",
@@ -569,10 +929,38 @@
},
"id": "TextSpan"
},
- "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.",
+ "Token": {
+ "description": "Represents the smallest syntactic building block of the text.",
"type": "object",
"properties": {
+ "partOfSpeech": {
+ "$ref": "PartOfSpeech",
+ "description": "Parts of speech tag for this token."
+ },
+ "text": {
+ "$ref": "TextSpan",
+ "description": "The token text."
+ },
+ "dependencyEdge": {
+ "description": "Dependency tree parse for this token.",
+ "$ref": "DependencyEdge"
+ },
+ "lemma": {
+ "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
+ "type": "string"
+ }
+ },
+ "id": "Token"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
@@ -581,26 +969,23 @@
"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"
},
"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": {
"extractSyntax": {
- "description": "Extract syntax information.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Extract syntax information."
},
"extractDocumentSentiment": {
"description": "Extract document-level sentiment.",
@@ -611,43 +996,39 @@
"type": "boolean"
}
},
- "id": "Features",
- "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
- "type": "object"
+ "id": "Features"
},
"EntityMention": {
"description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
"type": "object",
"properties": {
"text": {
- "description": "The mention text.",
- "$ref": "TextSpan"
+ "$ref": "TextSpan",
+ "description": "The mention text."
},
"type": {
- "enum": [
- "TYPE_UNKNOWN",
- "PROPER",
- "COMMON"
- ],
- "description": "The type of the entity mention.",
"type": "string",
"enumDescriptions": [
"Unknown",
"Proper name",
"Common noun (or noun compound)"
- ]
+ ],
+ "enum": [
+ "TYPE_UNKNOWN",
+ "PROPER",
+ "COMMON"
+ ],
+ "description": "The type of the entity mention."
}
},
"id": "EntityMention"
},
"Document": {
+ "description": "################################################################ #\n\nRepresents the input to API methods.",
+ "type": "object",
"properties": {
- "gcsContentUri": {
- "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
- "type": "string"
- },
"language": {
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](https://cloud.google.com/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
"type": "string"
},
"type": {
@@ -665,417 +1046,36 @@
"type": "string"
},
"content": {
- "description": "The content of the input in string format.",
+ "type": "string",
+ "description": "The content of the input in string format."
+ },
+ "gcsContentUri": {
+ "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
"type": "string"
}
},
- "id": "Document",
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object"
+ "id": "Document"
},
"Sentence": {
+ "description": "Represents a sentence in the input document.",
+ "type": "object",
"properties": {
"sentiment": {
"$ref": "Sentiment",
"description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
},
"text": {
- "description": "The sentence text.",
- "$ref": "TextSpan"
+ "$ref": "TextSpan",
+ "description": "The sentence text."
}
},
- "id": "Sentence",
- "description": "Represents a sentence in the input document.",
- "type": "object"
- },
- "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"
- },
- "Sentiment": {
- "properties": {
- "magnitude": {
- "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
- "format": "float",
- "type": "number"
- },
- "polarity": {
- "description": "DEPRECATED FIELD - This field is being deprecated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.google.com/natural-language/docs for more information.",
- "format": "float",
- "type": "number"
- },
- "score": {
- "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
- "format": "float",
- "type": "number"
- }
- },
- "id": "Sentiment",
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
- "type": "object"
- },
- "PartOfSpeech": {
- "properties": {
- "mood": {
- "enum": [
- "MOOD_UNKNOWN",
- "CONDITIONAL_MOOD",
- "IMPERATIVE",
- "INDICATIVE",
- "INTERROGATIVE",
- "JUSSIVE",
- "SUBJUNCTIVE"
- ],
- "description": "The grammatical mood.",
- "type": "string",
- "enumDescriptions": [
- "Mood is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Imperative",
- "Indicative",
- "Interrogative",
- "Jussive",
- "Subjunctive"
- ]
- },
- "tag": {
- "enum": [
- "UNKNOWN",
- "ADJ",
- "ADP",
- "ADV",
- "CONJ",
- "DET",
- "NOUN",
- "NUM",
- "PRON",
- "PRT",
- "PUNCT",
- "VERB",
- "X",
- "AFFIX"
- ],
- "description": "The part of speech tag.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Adjective",
- "Adposition (preposition and postposition)",
- "Adverb",
- "Conjunction",
- "Determiner",
- "Noun (common and proper)",
- "Cardinal number",
- "Pronoun",
- "Particle or other function word",
- "Punctuation",
- "Verb (all tenses and modes)",
- "Other: foreign words, typos, abbreviations",
- "Affix"
- ]
- },
- "gender": {
- "enumDescriptions": [
- "Gender is not applicable in the analyzed language or is not predicted.",
- "Feminine",
- "Masculine",
- "Neuter"
- ],
- "enum": [
- "GENDER_UNKNOWN",
- "FEMININE",
- "MASCULINE",
- "NEUTER"
- ],
- "description": "The grammatical gender.",
- "type": "string"
- },
- "person": {
- "enum": [
- "PERSON_UNKNOWN",
- "FIRST",
- "SECOND",
- "THIRD",
- "REFLEXIVE_PERSON"
- ],
- "description": "The grammatical person.",
- "type": "string",
- "enumDescriptions": [
- "Person is not applicable in the analyzed language or is not predicted.",
- "First",
- "Second",
- "Third",
- "Reflexive"
- ]
- },
- "proper": {
- "enumDescriptions": [
- "Proper is not applicable in the analyzed language or is not predicted.",
- "Proper",
- "Not proper"
- ],
- "enum": [
- "PROPER_UNKNOWN",
- "PROPER",
- "NOT_PROPER"
- ],
- "description": "The grammatical properness.",
- "type": "string"
- },
- "case": {
- "enumDescriptions": [
- "Case is not applicable in the analyzed language or is not predicted.",
- "Accusative",
- "Adverbial",
- "Complementive",
- "Dative",
- "Genitive",
- "Instrumental",
- "Locative",
- "Nominative",
- "Oblique",
- "Partitive",
- "Prepositional",
- "Reflexive",
- "Relative",
- "Vocative"
- ],
- "enum": [
- "CASE_UNKNOWN",
- "ACCUSATIVE",
- "ADVERBIAL",
- "COMPLEMENTIVE",
- "DATIVE",
- "GENITIVE",
- "INSTRUMENTAL",
- "LOCATIVE",
- "NOMINATIVE",
- "OBLIQUE",
- "PARTITIVE",
- "PREPOSITIONAL",
- "REFLEXIVE_CASE",
- "RELATIVE_CASE",
- "VOCATIVE"
- ],
- "description": "The grammatical case.",
- "type": "string"
- },
- "tense": {
- "enumDescriptions": [
- "Tense is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Future",
- "Past",
- "Present",
- "Imperfect",
- "Pluperfect"
- ],
- "enum": [
- "TENSE_UNKNOWN",
- "CONDITIONAL_TENSE",
- "FUTURE",
- "PAST",
- "PRESENT",
- "IMPERFECT",
- "PLUPERFECT"
- ],
- "description": "The grammatical tense.",
- "type": "string"
- },
- "reciprocity": {
- "enumDescriptions": [
- "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
- "Reciprocal",
- "Non-reciprocal"
- ],
- "enum": [
- "RECIPROCITY_UNKNOWN",
- "RECIPROCAL",
- "NON_RECIPROCAL"
- ],
- "description": "The grammatical reciprocity.",
- "type": "string"
- },
- "form": {
- "enumDescriptions": [
- "Form is not applicable in the analyzed language or is not predicted.",
- "Adnomial",
- "Auxiliary",
- "Complementizer",
- "Final ending",
- "Gerund",
- "Realis",
- "Irrealis",
- "Short form",
- "Long form",
- "Order form",
- "Specific form"
- ],
- "enum": [
- "FORM_UNKNOWN",
- "ADNOMIAL",
- "AUXILIARY",
- "COMPLEMENTIZER",
- "FINAL_ENDING",
- "GERUND",
- "REALIS",
- "IRREALIS",
- "SHORT",
- "LONG",
- "ORDER",
- "SPECIFIC"
- ],
- "description": "The grammatical form.",
- "type": "string"
- },
- "number": {
- "enum": [
- "NUMBER_UNKNOWN",
- "SINGULAR",
- "PLURAL",
- "DUAL"
- ],
- "description": "The grammatical number.",
- "type": "string",
- "enumDescriptions": [
- "Number is not applicable in the analyzed language or is not predicted.",
- "Singular",
- "Plural",
- "Dual"
- ]
- },
- "voice": {
- "enumDescriptions": [
- "Voice is not applicable in the analyzed language or is not predicted.",
- "Active",
- "Causative",
- "Passive"
- ],
- "enum": [
- "VOICE_UNKNOWN",
- "ACTIVE",
- "CAUSATIVE",
- "PASSIVE"
- ],
- "description": "The grammatical voice.",
- "type": "string"
- },
- "aspect": {
- "enumDescriptions": [
- "Aspect is not applicable in the analyzed language or is not predicted.",
- "Perfective",
- "Imperfective",
- "Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
- ],
- "description": "The grammatical aspect.",
- "type": "string"
- }
- },
- "id": "PartOfSpeech",
- "description": "Represents part of speech information for a token.",
- "type": "object"
- },
- "AnalyzeSyntaxRequest": {
- "properties": {
- "encodingType": {
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ]
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "AnalyzeSyntaxRequest",
- "description": "The syntax analysis request message.",
- "type": "object"
- },
- "AnalyzeSentimentResponse": {
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "type": "array",
- "items": {
- "$ref": "Sentence"
- }
- },
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment of the input document."
- }
- },
- "id": "AnalyzeSentimentResponse",
- "description": "The sentiment analysis response message.",
- "type": "object"
- },
- "AnalyzeEntitiesResponse": {
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "entities": {
- "description": "The recognized entities in the input document.",
- "type": "array",
- "items": {
- "$ref": "Entity"
- }
- }
- },
- "id": "AnalyzeEntitiesResponse",
- "description": "The entity analysis response message.",
- "type": "object"
+ "id": "Sentence"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"canonicalName": "Cloud Natural Language",
"auth": {
diff --git a/language/v1beta1/language-gen.go b/language/v1beta1/language-gen.go
index 3a73546..d7cb437 100644
--- a/language/v1beta1/language-gen.go
+++ b/language/v1beta1/language-gen.go
@@ -627,10 +627,8 @@
// automatically detected). Both ISO and BCP-47 language codes
// are
// accepted.<br>
- // [Language
- // Support](https://cloud.google.com/natural-language/docs/languages)
- // lis
- // ts currently supported languages for each API method.
+ // [Language Support](/natural-language/docs/languages)
+ // lists currently supported languages for each API method.
// If the language (either specified by the caller or automatically
// detected)
// is not supported by the called API method, an `INVALID_ARGUMENT`
@@ -1137,7 +1135,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -1170,7 +1168,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
diff --git a/language/v1beta2/language-api.json b/language/v1beta2/language-api.json
index 6d2e671..635aac1 100644
--- a/language/v1beta2/language-api.json
+++ b/language/v1beta2/language-api.json
@@ -1,94 +1,377 @@
{
+ "title": "Google Cloud Natural Language API",
+ "ownerName": "Google",
+ "resources": {
+ "documents": {
+ "methods": {
+ "annotateText": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnnotateTextResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta2/documents:annotateText",
+ "id": "language.documents.annotateText",
+ "path": "v1beta2/documents:annotateText",
+ "description": "A convenience method that provides all syntax, sentiment, entity, and\nclassification features in one call.",
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ }
+ },
+ "analyzeEntitySentiment": {
+ "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.",
+ "request": {
+ "$ref": "AnalyzeEntitySentimentRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeEntitySentimentResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta2/documents:analyzeEntitySentiment",
+ "id": "language.documents.analyzeEntitySentiment",
+ "path": "v1beta2/documents:analyzeEntitySentiment"
+ },
+ "analyzeEntities": {
+ "flatPath": "v1beta2/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities",
+ "path": "v1beta2/documents:analyzeEntities",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeEntitiesResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "analyzeSyntax": {
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/documents:analyzeSyntax",
+ "path": "v1beta2/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "request": {
+ "$ref": "AnalyzeSyntaxRequest"
+ },
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties."
+ },
+ "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": "v1beta2/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "path": "v1beta2/documents:analyzeSentiment"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ }
+ },
+ "version": "v1beta2",
+ "baseUrl": "https://language.googleapis.com/",
+ "servicePath": "",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "language:v1beta2",
+ "documentationLink": "https://cloud.google.com/natural-language/",
+ "revision": "20170525",
+ "discoveryVersion": "v1",
+ "version_module": "True",
"schemas": {
- "Entity": {
+ "Token": {
+ "description": "Represents the smallest syntactic building block of the text.",
"type": "object",
"properties": {
- "name": {
- "description": "The representative name for the entity.",
+ "text": {
+ "$ref": "TextSpan",
+ "description": "The token text."
+ },
+ "dependencyEdge": {
+ "description": "Dependency tree parse for this token.",
+ "$ref": "DependencyEdge"
+ },
+ "lemma": {
+ "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
"type": "string"
},
+ "partOfSpeech": {
+ "description": "Parts of speech tag for this token.",
+ "$ref": "PartOfSpeech"
+ }
+ },
+ "id": "Token"
+ },
+ "TextSpan": {
+ "description": "Represents an output piece of text.",
+ "type": "object",
+ "properties": {
+ "beginOffset": {
+ "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "content": {
+ "description": "The content of the output text.",
+ "type": "string"
+ }
+ },
+ "id": "TextSpan"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There 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"
+ },
+ "EntityMention": {
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "The mention text.",
+ "$ref": "TextSpan"
+ },
"type": {
- "enum": [
- "UNKNOWN",
- "PERSON",
- "LOCATION",
- "ORGANIZATION",
- "EVENT",
- "WORK_OF_ART",
- "CONSUMER_GOOD",
- "OTHER"
- ],
- "description": "The entity type.",
+ "description": "The type of the entity mention.",
"type": "string",
"enumDescriptions": [
"Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
+ "Proper name",
+ "Common noun (or noun compound)"
+ ],
+ "enum": [
+ "TYPE_UNKNOWN",
+ "PROPER",
+ "COMMON"
]
},
- "metadata": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively."
- },
- "salience": {
- "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
- "format": "float",
- "type": "number"
- },
"sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document."
- },
- "mentions": {
- "type": "array",
- "items": {
- "$ref": "EntityMention"
- },
- "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions."
+ "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document.",
+ "$ref": "Sentiment"
}
},
- "id": "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."
+ "id": "EntityMention"
},
- "AnalyzeSyntaxResponse": {
- "description": "The syntax analysis response message.",
+ "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": {
- "tokens": {
- "description": "Tokens, along with their syntactic information, in the input document.",
- "type": "array",
- "items": {
- "$ref": "Token"
- }
+ "extractSyntax": {
+ "description": "Extract syntax information.",
+ "type": "boolean"
},
+ "extractDocumentSentiment": {
+ "description": "Extract document-level sentiment.",
+ "type": "boolean"
+ },
+ "extractEntitySentiment": {
+ "description": "Extract entities and their associated sentiment.",
+ "type": "boolean"
+ },
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ }
+ },
+ "id": "Features"
+ },
+ "Document": {
+ "description": "################################################################ #\n\nRepresents the input to API methods.",
+ "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.",
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
"type": "string"
},
- "sentences": {
- "type": "array",
- "items": {
- "$ref": "Sentence"
- },
- "description": "Sentences in the input document."
+ "type": {
+ "enumDescriptions": [
+ "The content type is not specified.",
+ "Plain text",
+ "HTML"
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PLAIN_TEXT",
+ "HTML"
+ ],
+ "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
+ "type": "string"
+ },
+ "content": {
+ "description": "The content of the input in string format.",
+ "type": "string"
+ },
+ "gcsContentUri": {
+ "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
+ "type": "string"
}
},
- "id": "AnalyzeSyntaxResponse"
+ "id": "Document"
},
- "AnnotateTextRequest": {
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "Sentence": {
+ "description": "Represents a sentence in the input document.",
"type": "object",
"properties": {
+ "text": {
+ "description": "The sentence text.",
+ "$ref": "TextSpan"
+ },
+ "sentiment": {
+ "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence.",
+ "$ref": "Sentiment"
+ }
+ },
+ "id": "Sentence"
+ },
+ "AnalyzeEntitiesRequest": {
+ "description": "The entity analysis request message.",
+ "type": "object",
+ "properties": {
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ },
"encodingType": {
- "type": "string",
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
@@ -101,7 +384,510 @@
"UTF16",
"UTF32"
],
- "description": "The encoding type used by the API to calculate offsets."
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string"
+ }
+ },
+ "id": "AnalyzeEntitiesRequest"
+ },
+ "Sentiment": {
+ "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
+ "type": "object",
+ "properties": {
+ "score": {
+ "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
+ "format": "float",
+ "type": "number"
+ },
+ "magnitude": {
+ "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "Sentiment"
+ },
+ "AnalyzeEntitySentimentResponse": {
+ "description": "The entity-level sentiment analysis response message.",
+ "type": "object",
+ "properties": {
+ "entities": {
+ "description": "The recognized entities in the input document with associated sentiments.",
+ "type": "array",
+ "items": {
+ "$ref": "Entity"
+ }
+ },
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ }
+ },
+ "id": "AnalyzeEntitySentimentResponse"
+ },
+ "AnalyzeEntitySentimentRequest": {
+ "description": "The entity-level sentiment analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ]
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeEntitySentimentRequest"
+ },
+ "PartOfSpeech": {
+ "description": "Represents part of speech information for a token.",
+ "type": "object",
+ "properties": {
+ "proper": {
+ "description": "The grammatical properness.",
+ "type": "string",
+ "enumDescriptions": [
+ "Proper is not applicable in the analyzed language or is not predicted.",
+ "Proper",
+ "Not proper"
+ ],
+ "enum": [
+ "PROPER_UNKNOWN",
+ "PROPER",
+ "NOT_PROPER"
+ ]
+ },
+ "case": {
+ "enumDescriptions": [
+ "Case is not applicable in the analyzed language or is not predicted.",
+ "Accusative",
+ "Adverbial",
+ "Complementive",
+ "Dative",
+ "Genitive",
+ "Instrumental",
+ "Locative",
+ "Nominative",
+ "Oblique",
+ "Partitive",
+ "Prepositional",
+ "Reflexive",
+ "Relative",
+ "Vocative"
+ ],
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
+ ],
+ "description": "The grammatical case.",
+ "type": "string"
+ },
+ "tense": {
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ],
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "FUTURE",
+ "PAST",
+ "PRESENT",
+ "IMPERFECT",
+ "PLUPERFECT"
+ ],
+ "description": "The grammatical tense.",
+ "type": "string"
+ },
+ "reciprocity": {
+ "enumDescriptions": [
+ "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
+ "Reciprocal",
+ "Non-reciprocal"
+ ],
+ "enum": [
+ "RECIPROCITY_UNKNOWN",
+ "RECIPROCAL",
+ "NON_RECIPROCAL"
+ ],
+ "description": "The grammatical reciprocity.",
+ "type": "string"
+ },
+ "form": {
+ "description": "The grammatical form.",
+ "type": "string",
+ "enumDescriptions": [
+ "Form is not applicable in the analyzed language or is not predicted.",
+ "Adnomial",
+ "Auxiliary",
+ "Complementizer",
+ "Final ending",
+ "Gerund",
+ "Realis",
+ "Irrealis",
+ "Short form",
+ "Long form",
+ "Order form",
+ "Specific form"
+ ],
+ "enum": [
+ "FORM_UNKNOWN",
+ "ADNOMIAL",
+ "AUXILIARY",
+ "COMPLEMENTIZER",
+ "FINAL_ENDING",
+ "GERUND",
+ "REALIS",
+ "IRREALIS",
+ "SHORT",
+ "LONG",
+ "ORDER",
+ "SPECIFIC"
+ ]
+ },
+ "number": {
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ],
+ "enum": [
+ "NUMBER_UNKNOWN",
+ "SINGULAR",
+ "PLURAL",
+ "DUAL"
+ ],
+ "description": "The grammatical number.",
+ "type": "string"
+ },
+ "voice": {
+ "description": "The grammatical voice.",
+ "type": "string",
+ "enumDescriptions": [
+ "Voice is not applicable in the analyzed language or is not predicted.",
+ "Active",
+ "Causative",
+ "Passive"
+ ],
+ "enum": [
+ "VOICE_UNKNOWN",
+ "ACTIVE",
+ "CAUSATIVE",
+ "PASSIVE"
+ ]
+ },
+ "aspect": {
+ "enumDescriptions": [
+ "Aspect is not applicable in the analyzed language or is not predicted.",
+ "Perfective",
+ "Imperfective",
+ "Progressive"
+ ],
+ "enum": [
+ "ASPECT_UNKNOWN",
+ "PERFECTIVE",
+ "IMPERFECTIVE",
+ "PROGRESSIVE"
+ ],
+ "description": "The grammatical aspect.",
+ "type": "string"
+ },
+ "mood": {
+ "enumDescriptions": [
+ "Mood is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Imperative",
+ "Indicative",
+ "Interrogative",
+ "Jussive",
+ "Subjunctive"
+ ],
+ "enum": [
+ "MOOD_UNKNOWN",
+ "CONDITIONAL_MOOD",
+ "IMPERATIVE",
+ "INDICATIVE",
+ "INTERROGATIVE",
+ "JUSSIVE",
+ "SUBJUNCTIVE"
+ ],
+ "description": "The grammatical mood.",
+ "type": "string"
+ },
+ "tag": {
+ "enumDescriptions": [
+ "Unknown",
+ "Adjective",
+ "Adposition (preposition and postposition)",
+ "Adverb",
+ "Conjunction",
+ "Determiner",
+ "Noun (common and proper)",
+ "Cardinal number",
+ "Pronoun",
+ "Particle or other function word",
+ "Punctuation",
+ "Verb (all tenses and modes)",
+ "Other: foreign words, typos, abbreviations",
+ "Affix"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ],
+ "description": "The part of speech tag.",
+ "type": "string"
+ },
+ "gender": {
+ "enumDescriptions": [
+ "Gender is not applicable in the analyzed language or is not predicted.",
+ "Feminine",
+ "Masculine",
+ "Neuter"
+ ],
+ "enum": [
+ "GENDER_UNKNOWN",
+ "FEMININE",
+ "MASCULINE",
+ "NEUTER"
+ ],
+ "description": "The grammatical gender.",
+ "type": "string"
+ },
+ "person": {
+ "description": "The grammatical person.",
+ "type": "string",
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ],
+ "enum": [
+ "PERSON_UNKNOWN",
+ "FIRST",
+ "SECOND",
+ "THIRD",
+ "REFLEXIVE_PERSON"
+ ]
+ }
+ },
+ "id": "PartOfSpeech"
+ },
+ "AnalyzeSyntaxRequest": {
+ "description": "The syntax analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string"
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ }
+ },
+ "id": "AnalyzeSyntaxRequest"
+ },
+ "AnalyzeSentimentResponse": {
+ "description": "The sentiment analysis response message.",
+ "type": "object",
+ "properties": {
+ "documentSentiment": {
+ "description": "The overall sentiment of the input document.",
+ "$ref": "Sentiment"
+ },
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "sentences": {
+ "description": "The sentiment for all the sentences in the document.",
+ "type": "array",
+ "items": {
+ "$ref": "Sentence"
+ }
+ }
+ },
+ "id": "AnalyzeSentimentResponse"
+ },
+ "AnalyzeEntitiesResponse": {
+ "description": "The entity analysis response message.",
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "entities": {
+ "description": "The recognized entities in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "Entity"
+ }
+ }
+ },
+ "id": "AnalyzeEntitiesResponse"
+ },
+ "Entity": {
+ "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The representative name for the entity.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The entity type.",
+ "type": "string",
+ "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": {
+ "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"
+ },
+ "sentiment": {
+ "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document.",
+ "$ref": "Sentiment"
+ },
+ "mentions": {
+ "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityMention"
+ }
+ }
+ },
+ "id": "Entity"
+ },
+ "AnalyzeSyntaxResponse": {
+ "description": "The syntax analysis response message.",
+ "type": "object",
+ "properties": {
+ "sentences": {
+ "description": "Sentences in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "Sentence"
+ }
+ },
+ "tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "Token"
+ }
+ },
+ "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"
+ },
+ "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": {
"$ref": "Document",
@@ -118,12 +904,27 @@
"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",
+ "items": {
+ "$ref": "Sentence"
+ }
+ },
"tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
"type": "array",
"items": {
"$ref": "Token"
- },
- "description": "Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax."
+ }
},
"entities": {
"description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
@@ -131,29 +932,20 @@
"items": {
"$ref": "Entity"
}
- },
- "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."
- },
- "sentences": {
- "type": "array",
- "items": {
- "$ref": "Sentence"
- },
- "description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax."
}
},
"id": "AnnotateTextResponse"
},
"AnalyzeSentimentRequest": {
+ "description": "The sentiment analysis request message.",
"type": "object",
"properties": {
+ "document": {
+ "description": "Input document.",
+ "$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`.",
@@ -166,100 +958,21 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment."
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
+ ]
}
},
- "id": "AnalyzeSentimentRequest",
- "description": "The sentiment analysis request message."
+ "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": {
- "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": [
@@ -340,605 +1053,89 @@
"Compound of numeric modifier",
"Copula",
"Dislocated relation (for fronted/topicalized elements)"
- ]
- },
- "headTokenIndex": {
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DependencyEdge",
- "description": "Represents dependency parse tree information for a token."
- },
- "Token": {
- "description": "Represents the smallest syntactic building block of the text.",
- "type": "object",
- "properties": {
- "text": {
- "$ref": "TextSpan",
- "description": "The token text."
- },
- "dependencyEdge": {
- "$ref": "DependencyEdge",
- "description": "Dependency tree parse for this token."
- },
- "lemma": {
- "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
- "type": "string"
- },
- "partOfSpeech": {
- "$ref": "PartOfSpeech",
- "description": "Parts of speech tag for this token."
- }
- },
- "id": "Token"
- },
- "TextSpan": {
- "description": "Represents an output piece of text.",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "description": "The content of the output text."
- },
- "beginOffset": {
- "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TextSpan"
- },
- "Status": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "description": "A list of messages that carry the error details. There 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": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` 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."
- },
- "Features": {
- "type": "object",
- "properties": {
- "extractEntities": {
- "type": "boolean",
- "description": "Extract entities."
- },
- "extractSyntax": {
- "type": "boolean",
- "description": "Extract syntax information."
- },
- "extractDocumentSentiment": {
- "description": "Extract document-level sentiment.",
- "type": "boolean"
- },
- "extractEntitySentiment": {
- "description": "Extract entities and their associated sentiment.",
- "type": "boolean"
- }
- },
- "id": "Features",
- "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input."
- },
- "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": {
- "enum": [
- "TYPE_UNKNOWN",
- "PROPER",
- "COMMON"
- ],
- "description": "The type of the entity mention.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ]
- },
- "sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document."
- }
- },
- "id": "EntityMention"
- },
- "Document": {
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object",
- "properties": {
- "language": {
- "type": "string",
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](https://cloud.google.com/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned."
- },
- "type": {
- "type": "string",
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "PLAIN_TEXT",
- "HTML"
- ],
- "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error."
- },
- "content": {
- "description": "The content of the input in string format.",
- "type": "string"
- },
- "gcsContentUri": {
- "type": "string",
- "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported."
- }
- },
- "id": "Document"
- },
- "Sentence": {
- "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",
- "description": "Represents a sentence in the input document."
- },
- "AnalyzeEntitiesRequest": {
- "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",
- "description": "The entity analysis request message."
- },
- "Sentiment": {
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
- "type": "object",
- "properties": {
- "score": {
- "type": "number",
- "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
- "format": "float"
- },
- "magnitude": {
- "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
- "format": "float",
- "type": "number"
- }
- },
- "id": "Sentiment"
- },
- "AnalyzeEntitySentimentResponse": {
- "type": "object",
- "properties": {
- "entities": {
- "description": "The recognized entities in the input document with associated sentiments.",
- "type": "array",
- "items": {
- "$ref": "Entity"
- }
- },
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- }
- },
- "id": "AnalyzeEntitySentimentResponse",
- "description": "The entity-level sentiment analysis response message."
- },
- "AnalyzeEntitySentimentRequest": {
- "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": "AnalyzeEntitySentimentRequest",
- "description": "The entity-level sentiment analysis request message."
- },
- "PartOfSpeech": {
- "description": "Represents part of speech information for a token.",
- "type": "object",
- "properties": {
- "gender": {
- "type": "string",
- "enumDescriptions": [
- "Gender is not applicable in the analyzed language or is not predicted.",
- "Feminine",
- "Masculine",
- "Neuter"
- ],
- "enum": [
- "GENDER_UNKNOWN",
- "FEMININE",
- "MASCULINE",
- "NEUTER"
- ],
- "description": "The grammatical gender."
- },
- "person": {
- "enum": [
- "PERSON_UNKNOWN",
- "FIRST",
- "SECOND",
- "THIRD",
- "REFLEXIVE_PERSON"
- ],
- "description": "The grammatical person.",
- "type": "string",
- "enumDescriptions": [
- "Person is not applicable in the analyzed language or is not predicted.",
- "First",
- "Second",
- "Third",
- "Reflexive"
- ]
- },
- "proper": {
- "enum": [
- "PROPER_UNKNOWN",
- "PROPER",
- "NOT_PROPER"
- ],
- "description": "The grammatical properness.",
- "type": "string",
- "enumDescriptions": [
- "Proper is not applicable in the analyzed language or is not predicted.",
- "Proper",
- "Not proper"
- ]
- },
- "case": {
- "enum": [
- "CASE_UNKNOWN",
- "ACCUSATIVE",
- "ADVERBIAL",
- "COMPLEMENTIVE",
- "DATIVE",
- "GENITIVE",
- "INSTRUMENTAL",
- "LOCATIVE",
- "NOMINATIVE",
- "OBLIQUE",
- "PARTITIVE",
- "PREPOSITIONAL",
- "REFLEXIVE_CASE",
- "RELATIVE_CASE",
- "VOCATIVE"
- ],
- "description": "The grammatical case.",
- "type": "string",
- "enumDescriptions": [
- "Case is not applicable in the analyzed language or is not predicted.",
- "Accusative",
- "Adverbial",
- "Complementive",
- "Dative",
- "Genitive",
- "Instrumental",
- "Locative",
- "Nominative",
- "Oblique",
- "Partitive",
- "Prepositional",
- "Reflexive",
- "Relative",
- "Vocative"
- ]
- },
- "tense": {
- "type": "string",
- "enumDescriptions": [
- "Tense is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Future",
- "Past",
- "Present",
- "Imperfect",
- "Pluperfect"
- ],
- "enum": [
- "TENSE_UNKNOWN",
- "CONDITIONAL_TENSE",
- "FUTURE",
- "PAST",
- "PRESENT",
- "IMPERFECT",
- "PLUPERFECT"
- ],
- "description": "The grammatical tense."
- },
- "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"
- ],
- "description": "The grammatical reciprocity."
- },
- "form": {
- "type": "string",
- "enumDescriptions": [
- "Form is not applicable in the analyzed language or is not predicted.",
- "Adnomial",
- "Auxiliary",
- "Complementizer",
- "Final ending",
- "Gerund",
- "Realis",
- "Irrealis",
- "Short form",
- "Long form",
- "Order form",
- "Specific form"
- ],
- "enum": [
- "FORM_UNKNOWN",
- "ADNOMIAL",
- "AUXILIARY",
- "COMPLEMENTIZER",
- "FINAL_ENDING",
- "GERUND",
- "REALIS",
- "IRREALIS",
- "SHORT",
- "LONG",
- "ORDER",
- "SPECIFIC"
- ],
- "description": "The grammatical 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": {
- "type": "string",
- "enumDescriptions": [
- "Aspect is not applicable in the analyzed language or is not predicted.",
- "Perfective",
- "Imperfective",
- "Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
- ],
- "description": "The grammatical aspect."
- },
- "mood": {
- "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": {
- "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",
+ "ABBREV",
+ "ACOMP",
+ "ADVCL",
+ "ADVMOD",
+ "AMOD",
+ "APPOS",
+ "ATTR",
+ "AUX",
+ "AUXPASS",
+ "CC",
+ "CCOMP",
"CONJ",
+ "CSUBJ",
+ "CSUBJPASS",
+ "DEP",
"DET",
- "NOUN",
+ "DISCOURSE",
+ "DOBJ",
+ "EXPL",
+ "GOESWITH",
+ "IOBJ",
+ "MARK",
+ "MWE",
+ "MWV",
+ "NEG",
+ "NN",
+ "NPADVMOD",
+ "NSUBJ",
+ "NSUBJPASS",
"NUM",
- "PRON",
+ "NUMBER",
+ "P",
+ "PARATAXIS",
+ "PARTMOD",
+ "PCOMP",
+ "POBJ",
+ "POSS",
+ "POSTNEG",
+ "PRECOMP",
+ "PRECONJ",
+ "PREDET",
+ "PREF",
+ "PREP",
+ "PRONL",
"PRT",
- "PUNCT",
- "VERB",
- "X",
- "AFFIX"
- ],
- "description": "The part of speech tag."
+ "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"
+ ]
}
},
- "id": "PartOfSpeech"
- },
- "AnalyzeSyntaxRequest": {
- "description": "The syntax analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets."
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "AnalyzeSyntaxRequest"
- },
- "AnalyzeSentimentResponse": {
- "type": "object",
- "properties": {
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment of the input document."
- },
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "type": "array",
- "items": {
- "$ref": "Sentence"
- }
- }
- },
- "id": "AnalyzeSentimentResponse",
- "description": "The sentiment analysis response message."
- },
- "AnalyzeEntitiesResponse": {
- "description": "The entity analysis response message.",
- "type": "object",
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "entities": {
- "type": "array",
- "items": {
- "$ref": "Entity"
- },
- "description": "The recognized entities in the input document."
- }
- },
- "id": "AnalyzeEntitiesResponse"
+ "id": "DependencyEdge"
}
},
"icons": {
@@ -959,202 +1156,5 @@
"rootUrl": "https://language.googleapis.com/",
"ownerDomain": "google.com",
"name": "language",
- "batchPath": "batch",
- "title": "Google Cloud Natural Language API",
- "ownerName": "Google",
- "resources": {
- "documents": {
- "methods": {
- "analyzeSyntax": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSyntaxResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta2/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax",
- "path": "v1beta2/documents:analyzeSyntax",
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
- "request": {
- "$ref": "AnalyzeSyntaxRequest"
- }
- },
- "analyzeSentiment": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSentimentResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
- "path": "v1beta2/documents:analyzeSentiment",
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- },
- "description": "Analyzes the sentiment of the provided text."
- },
- "annotateText": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/documents:annotateText",
- "id": "language.documents.annotateText",
- "path": "v1beta2/documents:annotateText",
- "request": {
- "$ref": "AnnotateTextRequest"
- },
- "description": "A convenience method that provides all syntax, sentiment, and entity\nfeatures in one call."
- },
- "analyzeEntitySentiment": {
- "flatPath": "v1beta2/documents:analyzeEntitySentiment",
- "path": "v1beta2/documents:analyzeEntitySentiment",
- "id": "language.documents.analyzeEntitySentiment",
- "request": {
- "$ref": "AnalyzeEntitySentimentRequest"
- },
- "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.",
- "response": {
- "$ref": "AnalyzeEntitySentimentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "analyzeEntities": {
- "response": {
- "$ref": "AnalyzeEntitiesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta2/documents:analyzeEntities",
- "path": "v1beta2/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities",
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
- "request": {
- "$ref": "AnalyzeEntitiesRequest"
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "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": {
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response."
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "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": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- }
- },
- "version": "v1beta2",
- "baseUrl": "https://language.googleapis.com/",
- "servicePath": "",
- "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.",
- "basePath": "",
- "id": "language:v1beta2",
- "documentationLink": "https://cloud.google.com/natural-language/",
- "revision": "20170502",
- "discoveryVersion": "v1",
- "version_module": "True"
+ "batchPath": "batch"
}
diff --git a/language/v1beta2/language-gen.go b/language/v1beta2/language-gen.go
index 9d53d1c..9faa945 100644
--- a/language/v1beta2/language-gen.go
+++ b/language/v1beta2/language-gen.go
@@ -720,10 +720,8 @@
// automatically detected). Both ISO and BCP-47 language codes
// are
// accepted.<br>
- // [Language
- // Support](https://cloud.google.com/natural-language/docs/languages)
- // lis
- // ts currently supported languages for each API method.
+ // [Language Support](/natural-language/docs/languages)
+ // lists currently supported languages for each API method.
// If the language (either specified by the caller or automatically
// detected)
// is not supported by the called API method, an `INVALID_ARGUMENT`
@@ -1242,7 +1240,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -1275,7 +1273,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
@@ -1906,8 +1904,8 @@
}
// AnnotateText: A convenience method that provides all syntax,
-// sentiment, and entity
-// features in one call.
+// sentiment, entity, and
+// classification features in one call.
func (r *DocumentsService) AnnotateText(annotatetextrequest *AnnotateTextRequest) *DocumentsAnnotateTextCall {
c := &DocumentsAnnotateTextCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.annotatetextrequest = annotatetextrequest
@@ -1997,7 +1995,7 @@
}
return ret, nil
// {
- // "description": "A convenience method that provides all syntax, sentiment, and entity\nfeatures in one call.",
+ // "description": "A convenience method that provides all syntax, sentiment, entity, and\nclassification features in one call.",
// "flatPath": "v1beta2/documents:annotateText",
// "httpMethod": "POST",
// "id": "language.documents.annotateText",
diff --git a/logging/v2/logging-api.json b/logging/v2/logging-api.json
index ed09f13..3bd8c15 100644
--- a/logging/v2/logging-api.json
+++ b/logging/v2/logging-api.json
@@ -1,1302 +1,118 @@
{
- "ownerDomain": "google.com",
- "name": "logging",
- "batchPath": "batch",
- "title": "Stackdriver Logging API",
- "ownerName": "Google",
- "resources": {
- "billingAccounts": {
- "resources": {
- "logs": {
- "methods": {
- "delete": {
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "httpMethod": "DELETE",
- "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": "^billingAccounts/[^/]+/logs/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry."
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}",
- "id": "logging.billingAccounts.logs.delete",
- "path": "v2/{+logName}"
- },
- "list": {
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/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": {
- "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",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "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}"
- },
- "list": {
- "id": "logging.billingAccounts.sinks.list",
- "path": "v2/{+parent}/sinks",
- "description": "Lists sinks.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "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"
- },
- "get": {
- "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"
- ],
- "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/[^/]+$"
- }
- }
- },
- "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": "^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}",
- "path": "v2/{+sinkName}",
- "id": "logging.billingAccounts.sinks.update"
- },
- "create": {
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
- "id": "logging.billingAccounts.sinks.create",
- "path": "v2/{+parent}/sinks",
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the 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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "parent": {
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "required": true,
- "type": "string"
- },
- "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"
- }
- }
- }
- }
- }
- }
- },
- "folders": {
- "resources": {
- "logs": {
- "methods": {
- "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",
- "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": {
- "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 resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/folders/{foldersId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.folders.logs.list"
- },
- "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": "^folders/[^/]+/logs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
- "path": "v2/{+logName}",
- "id": "logging.folders.logs.delete",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
- }
- }
- },
- "sinks": {
- "methods": {
- "list": {
- "flatPath": "v2/folders/{foldersId}/sinks",
- "id": "logging.folders.sinks.list",
- "path": "v2/{+parent}/sinks",
- "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": {
- "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 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": {
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.folders.sinks.get",
- "description": "Gets a sink."
- },
- "update": {
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.folders.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": "^folders/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "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"
- }
- }
- },
- "create": {
- "id": "logging.folders.sinks.create",
- "path": "v2/{+parent}/sinks",
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the 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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean",
- "location": "query"
- }
- },
- "flatPath": "v2/folders/{foldersId}/sinks"
- },
- "delete": {
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.folders.sinks.delete"
- }
- }
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "path": "v2/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": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32"
- }
- },
- "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"
- }
- }
- },
- "organizations": {
- "resources": {
- "logs": {
- "methods": {
- "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": {
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^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"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.organizations.logs.list",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
- },
- "delete": {
- "path": "v2/{+logName}",
- "id": "logging.organizations.logs.delete",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "parameterOrder": [
- "logName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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}"
- }
- }
- },
- "sinks": {
- "methods": {
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "parent": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "required": true,
- "type": "string"
- },
- "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/organizations/{organizationsId}/sinks",
- "id": "logging.organizations.sinks.create",
- "path": "v2/{+parent}/sinks"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/sinks/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "id": "logging.organizations.sinks.delete",
- "path": "v2/{+sinkName}",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
- },
- "list": {
- "flatPath": "v2/organizations/{organizationsId}/sinks",
- "id": "logging.organizations.sinks.list",
- "path": "v2/{+parent}/sinks",
- "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": {
- "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 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/[^/]+$"
- }
- }
- },
- "get": {
- "description": "Gets a sink.",
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/sinks/[^/]+$"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "id": "logging.organizations.sinks.get",
- "path": "v2/{+sinkName}"
- },
- "update": {
- "id": "logging.organizations.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"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/sinks/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
- "type": "boolean"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}"
- }
- }
- }
- }
- },
- "entries": {
- "methods": {
- "write": {
- "description": "Writes log entries to Stackdriver Logging.",
- "request": {
- "$ref": "WriteLogEntriesRequest"
- },
- "response": {
- "$ref": "WriteLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {},
- "flatPath": "v2/entries:write",
- "path": "v2/entries:write",
- "id": "logging.entries.write"
- },
- "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": {},
- "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"
- },
- "response": {
- "$ref": "ListLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- }
- }
- },
- "projects": {
- "resources": {
- "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": {
- "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"
- }
- },
- "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": {
- "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"
- ],
- "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": {
- "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"
- }
- },
- "flatPath": "v2/projects/{projectsId}/logs",
- "id": "logging.projects.logs.list",
- "path": "v2/{+parent}/logs"
- }
- }
- },
- "sinks": {
- "methods": {
- "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": {
- "parent": {
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "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": "v2/projects/{projectsId}/sinks",
- "id": "logging.projects.sinks.list",
- "path": "v2/{+parent}/sinks"
- },
- "get": {
- "description": "Gets a sink.",
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
- "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": {
- "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\"."
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "id": "logging.projects.sinks.get",
- "path": "v2/{+sinkName}"
- },
- "update": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
- "type": "boolean",
- "location": "query"
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "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"
- }
- },
- "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": {
- "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"
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.projects.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": {
- "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}",
- "path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
- }
- }
- },
- "metrics": {
- "methods": {
- "delete": {
- "parameters": {
- "metricName": {
- "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path"
- }
- },
- "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}",
- "id": "logging.projects.metrics.delete",
- "path": "v2/{+metricName}",
- "description": "Deletes a logs-based metric.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "metricName"
- ],
- "response": {
- "$ref": "Empty"
- }
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListLogMetricsResponse"
- },
- "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": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_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}/metrics",
- "id": "logging.projects.metrics.list",
- "path": "v2/{+parent}/metrics",
- "description": "Lists logs-based metrics."
- },
- "get": {
- "description": "Gets a logs-based metric.",
- "httpMethod": "GET",
- "parameterOrder": [
- "metricName"
- ],
- "response": {
- "$ref": "LogMetric"
- },
- "parameters": {
- "metricName": {
- "location": "path",
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.get",
- "path": "v2/{+metricName}"
- },
- "update": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "metricName": {
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "required": true,
- "type": "string"
- }
- },
- "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": {
- "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": "v2/projects/{projectsId}/metrics",
- "id": "logging.projects.metrics.create",
- "path": "v2/{+parent}/metrics",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates a logs-based metric."
- }
- }
- }
- }
- }
- },
- "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": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "quotaUser": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "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."
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v2",
"baseUrl": "https://logging.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Writes log entries and manages your Stackdriver Logging configuration.",
"servicePath": "",
"basePath": "",
- "documentationLink": "https://cloud.google.com/logging/docs/",
- "revision": "20170429",
"id": "logging:v2",
+ "revision": "20170530",
+ "documentationLink": "https://cloud.google.com/logging/docs/",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "MonitoredResource": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
+ "type": "object"
+ }
+ },
+ "id": "MonitoredResource",
+ "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n"
+ },
+ "WriteLogEntriesRequest": {
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
+ "type": "object"
+ },
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry."
+ },
+ "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",
+ "description": "The parameters to WriteLogEntries.",
+ "type": "object"
+ },
+ "LogSink": {
+ "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods."
+ },
+ "includeChildren": {
+ "description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND\nresource.type=gce_instance\n",
+ "type": "boolean"
+ },
+ "filter": {
+ "description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. 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"
+ },
+ "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": {
+ "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."
+ ],
+ "enum": [
+ "VERSION_FORMAT_UNSPECIFIED",
+ "V2",
+ "V1"
+ ]
+ }
+ },
+ "id": "LogSink"
+ },
"ListLogsResponse": {
- "description": "Result returned from ListLogs.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -1304,68 +120,20 @@
"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."
},
"logNames": {
+ "description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\".",
"type": "array",
"items": {
"type": "string"
- },
- "description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\"."
- }
- },
- "id": "ListLogsResponse"
- },
- "ListSinksResponse": {
- "description": "Result returned from ListSinks.",
- "type": "object",
- "properties": {
- "sinks": {
- "description": "A list of sinks.",
- "type": "array",
- "items": {
- "$ref": "LogSink"
}
- },
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.",
- "type": "string"
}
},
- "id": "ListSinksResponse"
+ "id": "ListLogsResponse",
+ "description": "Result returned from ListLogs."
},
"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": {
- "cacheFillBytes": {
- "type": "string",
- "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
- "format": "int64"
- },
- "requestMethod": {
- "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
- "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\"."
- },
- "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"
@@ -1387,20 +155,68 @@
"description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
"type": "string"
},
- "latency": {
- "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
- "format": "google-duration",
- "type": "string"
- },
"userAgent": {
"description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
"type": "string"
+ },
+ "latency": {
+ "type": "string",
+ "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
+ "format": "google-duration"
+ },
+ "cacheFillBytes": {
+ "type": "string",
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
+ "format": "int64"
+ },
+ "requestMethod": {
+ "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
+ "type": "string"
+ },
+ "requestSize": {
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "format": "int64",
+ "type": "string"
+ },
+ "responseSize": {
+ "type": "string",
+ "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "format": "int64"
+ },
+ "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"
}
},
"id": "HttpRequest"
},
+ "ListSinksResponse": {
+ "id": "ListSinksResponse",
+ "description": "Result returned from ListSinks.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken."
+ },
+ "sinks": {
+ "description": "A list of sinks.",
+ "type": "array",
+ "items": {
+ "$ref": "LogSink"
+ }
+ }
+ }
+ },
"LabelDescriptor": {
- "id": "LabelDescriptor",
"description": "A description of a label.",
"type": "object",
"properties": {
@@ -1413,25 +229,30 @@
"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"
+ "type": "string",
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ]
}
- }
+ },
+ "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": {
+ "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": {
"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"
@@ -1450,15 +271,12 @@
"items": {
"$ref": "LabelDescriptor"
}
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".",
- "type": "string"
}
},
"id": "MonitoredResourceDescriptor"
},
"LogEntrySourceLocation": {
+ "description": "Additional information about the source code location that produced the log entry.",
"type": "object",
"properties": {
"file": {
@@ -1466,8 +284,8 @@
"type": "string"
},
"function": {
- "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
- "type": "string"
+ "type": "string",
+ "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python)."
},
"line": {
"description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
@@ -1475,32 +293,43 @@
"type": "string"
}
},
- "id": "LogEntrySourceLocation",
- "description": "Additional information about the source code location that produced the log entry."
+ "id": "LogEntrySourceLocation"
},
"ListLogEntriesResponse": {
+ "description": "Result returned from ListLogEntries.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.",
+ "type": "string"
+ },
"entries": {
"description": "A list of log entries.",
"type": "array",
"items": {
"$ref": "LogEntry"
}
- },
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.",
- "type": "string"
}
},
- "id": "ListLogEntriesResponse",
- "description": "Result returned from ListLogEntries."
+ "id": "ListLogEntriesResponse"
},
"LogLine": {
+ "id": "LogLine",
"description": "Application log line emitted while processing a request.",
"type": "object",
"properties": {
"severity": {
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ],
"description": "Severity of this log entry.",
"type": "string",
"enumDescriptions": [
@@ -1513,52 +342,40 @@
"(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"
+ "type": "string",
+ "description": "App-provided log message."
},
"sourceLocation": {
"$ref": "SourceLocation",
"description": "Where in the source code this log message was written."
},
"time": {
+ "type": "string",
"description": "Approximate time when this log entry was made.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
}
- },
- "id": "LogLine"
+ }
},
"ListLogMetricsResponse": {
+ "id": "ListLogMetricsResponse",
"description": "Result returned from ListLogMetrics.",
"type": "object",
"properties": {
"metrics": {
+ "description": "A list of logs-based metrics.",
"type": "array",
"items": {
"$ref": "LogMetric"
- },
- "description": "A list of logs-based metrics."
+ }
},
"nextPageToken": {
"description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
"type": "string"
}
- },
- "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 {}.",
@@ -1568,6 +385,10 @@
},
"LogEntry": {
"properties": {
+ "trace": {
+ "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824",
+ "type": "string"
+ },
"labels": {
"additionalProperties": {
"type": "string"
@@ -1575,12 +396,7 @@
"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"
- },
"severity": {
- "type": "string",
"enumDescriptions": [
"(0) The log entry has no assigned severity level.",
"(100) Debug or trace information.",
@@ -1603,7 +419,8 @@
"ALERT",
"EMERGENCY"
],
- "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT."
+ "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
+ "type": "string"
},
"sourceLocation": {
"$ref": "LogEntrySourceLocation",
@@ -1614,25 +431,30 @@
"format": "google-datetime",
"type": "string"
},
+ "receiveTimestamp": {
+ "description": "Output only. The time the log entry was received by Stackdriver Logging.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"logName": {
- "type": "string",
- "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\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."
+ "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."
+ "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.",
+ "$ref": "MonitoredResource"
},
"httpRequest": {
- "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.",
- "$ref": "HttpRequest"
+ "$ref": "HttpRequest",
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
},
"jsonPayload": {
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- },
- "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
- "type": "object"
+ }
},
"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.",
@@ -1647,12 +469,12 @@
"type": "string"
},
"protoPayload": {
+ "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
- "type": "object"
+ }
}
},
"id": "LogEntry",
@@ -1663,10 +485,6 @@
"description": "Specifies a location in a source code file.",
"type": "object",
"properties": {
- "file": {
- "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
- "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"
@@ -1675,15 +493,27 @@
"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"
}
},
"id": "SourceLocation"
},
"ListLogEntriesRequest": {
- "id": "ListLogEntriesRequest",
"description": "The parameters to ListLogEntries.",
"type": "object",
"properties": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "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"
@@ -1695,32 +525,41 @@
"type": "string"
}
},
+ "filter": {
+ "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
+ "type": "string"
+ },
"projectIds": {
- "description": "Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: \"my-project-1A\". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names.",
"type": "array",
"items": {
"type": "string"
- }
- },
- "filter": {
- "type": "string",
- "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters."
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
+ },
+ "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."
}
- }
+ },
+ "id": "ListLogEntriesRequest"
},
"RequestLog": {
"description": "Complete log information about a single HTTP request to an App Engine application.",
"type": "object",
"properties": {
+ "megaCycles": {
+ "description": "Number of CPU megacycles used to process request.",
+ "format": "int64",
+ "type": "string"
+ },
+ "first": {
+ "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
+ "type": "boolean"
+ },
+ "versionId": {
+ "description": "Version of the application that handled this request.",
+ "type": "string"
+ },
+ "moduleId": {
+ "description": "Module of the application that handled this request.",
+ "type": "string"
+ },
"endTime": {
"description": "Time when the request finished.",
"format": "google-datetime",
@@ -1742,36 +581,36 @@
}
},
"responseSize": {
+ "type": "string",
"description": "Size in bytes sent back to client by request.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
},
"traceId": {
"description": "Stackdriver Trace identifier for this request.",
"type": "string"
},
"line": {
- "description": "A list of log lines emitted by the application while serving this request.",
"type": "array",
"items": {
"$ref": "LogLine"
- }
- },
- "taskQueueName": {
- "description": "Queue name of the request, in the case of an offline request.",
- "type": "string"
+ },
+ "description": "A list of log lines emitted by the application while serving this request."
},
"referrer": {
"description": "Referrer URL of request.",
"type": "string"
},
+ "taskQueueName": {
+ "description": "Queue name of the request, in the case of an offline request.",
+ "type": "string"
+ },
"requestId": {
- "type": "string",
- "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier."
+ "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.",
+ "type": "string"
},
"nickname": {
- "type": "string",
- "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21."
+ "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.",
+ "type": "string"
},
"status": {
"description": "HTTP response status code. Example: 200, 404.",
@@ -1796,9 +635,9 @@
"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",
- "type": "integer"
+ "format": "int32"
},
"host": {
"description": "Internet host and port number of the resource being requested.",
@@ -1813,9 +652,9 @@
"type": "string"
},
"startTime": {
- "type": "string",
"description": "Time when the request started.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"latency": {
"description": "Latency of the request.",
@@ -1823,20 +662,20 @@
"type": "string"
},
"ip": {
- "description": "Origin IP address.",
- "type": "string"
+ "type": "string",
+ "description": "Origin IP address."
},
"appId": {
- "type": "string",
- "description": "Application that handled this request."
+ "description": "Application that handled this request.",
+ "type": "string"
},
"appEngineRelease": {
"description": "App Engine release version.",
"type": "string"
},
"method": {
- "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
- "type": "string"
+ "type": "string",
+ "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\"."
},
"cost": {
"description": "An indication of the relative cost of serving this request.",
@@ -1846,23 +685,6 @@
"instanceId": {
"description": "An identifier for the instance that handled the request.",
"type": "string"
- },
- "megaCycles": {
- "description": "Number of CPU megacycles used to process request.",
- "format": "int64",
- "type": "string"
- },
- "first": {
- "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
- "type": "boolean"
- },
- "versionId": {
- "description": "Version of the application that handled this request.",
- "type": "string"
- },
- "moduleId": {
- "description": "Module of the application that handled this request.",
- "type": "string"
}
},
"id": "RequestLog"
@@ -1871,16 +693,16 @@
"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"
@@ -1889,22 +711,53 @@
"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": {
- "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"
+ },
+ "version": {
+ "enumDescriptions": [
+ "Stackdriver Logging API v2.",
+ "Stackdriver Logging API v1."
+ ],
+ "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"
},
"LogEntryOperation": {
"type": "object",
@@ -1928,139 +781,6 @@
},
"id": "LogEntryOperation",
"description": "Additional information about a potentially long-running operation with which a log entry is associated."
- },
- "LogMetric": {
- "id": "LogMetric",
- "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.",
- "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": {
- "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": {
- "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"
- }
- }
- },
- "MonitoredResource": {
- "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
- "type": "object"
- },
- "type": {
- "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
- "type": "string"
- }
- },
- "id": "MonitoredResource"
- },
- "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 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": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
- "type": "object"
- },
- "resource": {
- "$ref": "MonitoredResource",
- "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry."
- }
- },
- "id": "WriteLogEntriesRequest"
- },
- "LogSink": {
- "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.",
- "type": "object",
- "properties": {
- "includeChildren": {
- "description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are availble for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project-a/\" OR \"projects/test-project-b/\") AND\nresource.type=gce_instance\n",
- "type": "boolean"
- },
- "destination": {
- "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.",
- "type": "string"
- },
- "filter": {
- "description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. 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"
- },
- "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": {
- "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."
- ],
- "enum": [
- "VERSION_FORMAT_UNSPECIFIED",
- "V2",
- "V1"
- ]
- },
- "name": {
- "description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.",
- "type": "string"
- }
- },
- "id": "LogSink"
}
},
"icons": {
@@ -2090,5 +810,1290 @@
}
}
},
- "rootUrl": "https://logging.googleapis.com/"
+ "rootUrl": "https://logging.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "logging",
+ "batchPath": "batch",
+ "title": "Stackdriver Logging API",
+ "ownerName": "Google",
+ "resources": {
+ "folders": {
+ "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": "^folders/[^/]+/logs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
+ "id": "logging.folders.logs.delete",
+ "path": "v2/{+logName}",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
+ },
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/folders/{foldersId}/logs",
+ "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.",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "sinkName": {
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.folders.sinks.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": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/sinks",
+ "id": "logging.folders.sinks.list",
+ "path": "v2/{+parent}/sinks",
+ "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": {
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.folders.sinks.get",
+ "description": "Gets a sink."
+ },
+ "update": {
+ "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"
+ },
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ]
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/sinks",
+ "id": "logging.folders.sinks.create",
+ "path": "v2/{+parent}/sinks",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the 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."
+ }
+ }
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
+ "id": "logging.organizations.logs.delete",
+ "path": "v2/{+logName}",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "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/[^/]+$"
+ }
+ }
+ },
+ "list": {
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "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"
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "id": "logging.organizations.sinks.delete",
+ "path": "v2/{+sinkName}"
+ },
+ "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": {
+ "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": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks",
+ "id": "logging.organizations.sinks.list",
+ "path": "v2/{+parent}/sinks"
+ },
+ "get": {
+ "description": "Gets a sink.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "id": "logging.organizations.sinks.get",
+ "path": "v2/{+sinkName}"
+ },
+ "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": {
+ "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/organizations/{organizationsId}/sinks/{sinksId}",
+ "id": "logging.organizations.sinks.update",
+ "path": "v2/{+sinkName}"
+ },
+ "create": {
+ "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.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "entries": {
+ "methods": {
+ "list": {
+ "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
+ "request": {
+ "$ref": "ListLogEntriesRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListLogEntriesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {},
+ "flatPath": "v2/entries:list",
+ "id": "logging.entries.list",
+ "path": "v2/entries:list"
+ },
+ "write": {
+ "flatPath": "v2/entries:write",
+ "path": "v2/entries:write",
+ "id": "logging.entries.write",
+ "request": {
+ "$ref": "WriteLogEntriesRequest"
+ },
+ "description": "Writes log entries to Stackdriver Logging.",
+ "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"
+ ]
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "metrics": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "metricName": {
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.delete",
+ "path": "v2/{+metricName}",
+ "description": "Deletes a logs-based metric."
+ },
+ "list": {
+ "description": "Lists logs-based metrics.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListLogMetricsResponse"
+ },
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/projects/{projectsId}/metrics",
+ "id": "logging.projects.metrics.list",
+ "path": "v2/{+parent}/metrics"
+ },
+ "get": {
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "metricName": {
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2/{+metricName}",
+ "id": "logging.projects.metrics.get",
+ "description": "Gets a logs-based metric."
+ },
+ "update": {
+ "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"
+ ],
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2/{+metricName}",
+ "id": "logging.projects.metrics.update"
+ },
+ "create": {
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2/projects/{projectsId}/metrics",
+ "path": "v2/{+parent}/metrics",
+ "id": "logging.projects.metrics.create",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates a logs-based metric."
+ }
+ }
+ },
+ "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": "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": {
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "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 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"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/logs",
+ "path": "v2/{+parent}/logs",
+ "id": "logging.projects.logs.list"
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "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": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "id": "logging.projects.sinks.list",
+ "path": "v2/{+parent}/sinks",
+ "description": "Lists sinks."
+ },
+ "get": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "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."
+ },
+ "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": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.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": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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": {
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.projects.sinks.create",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the 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": {
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.projects.sinks.delete"
+ }
+ }
+ }
+ }
+ },
+ "billingAccounts": {
+ "resources": {
+ "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": "^billingAccounts/[^/]+/logs/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}",
+ "path": "v2/{+logName}",
+ "id": "logging.billingAccounts.logs.delete",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
+ },
+ "list": {
+ "parameters": {
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ }
+ },
+ "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",
+ "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": {
+ "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"
+ }
+ },
+ "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."
+ },
+ "list": {
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.billingAccounts.sinks.list",
+ "description": "Lists sinks.",
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "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": "^billingAccounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks"
+ },
+ "get": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.sinks.get",
+ "description": "Gets a sink.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "sinkName": {
+ "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"
+ }
+ }
+ },
+ "update": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.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.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ]
+ },
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
+ "id": "logging.billingAccounts.sinks.create",
+ "path": "v2/{+parent}/sinks"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "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"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ }
+ },
+ "version": "v2"
}
diff --git a/logging/v2/logging-gen.go b/logging/v2/logging-gen.go
index f52f121..f72aeb5 100644
--- a/logging/v2/logging-gen.go
+++ b/logging/v2/logging-gen.go
@@ -730,6 +730,10 @@
// log entry payloads.
ProtoPayload googleapi.RawMessage `json:"protoPayload,omitempty"`
+ // ReceiveTimestamp: Output only. The time the log entry was received by
+ // Stackdriver Logging.
+ ReceiveTimestamp string `json:"receiveTimestamp,omitempty"`
+
// Resource: 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
@@ -1035,17 +1039,17 @@
// IncludeChildren: Optional. This field applies only to sinks owned by
// organizations and folders. If the field is false, the default, only
- // the logs owned by the sink's parent resource are availble for export.
- // If the field is true, then logs from all the projects, folders, and
- // billing accounts contained in the sink's parent resource are also
- // available for export. Whether a particular log entry from the
- // children is exported depends on the sink's filter expression. For
+ // the logs owned by the sink's parent resource are available for
+ // export. If the field is true, then logs from all the projects,
+ // folders, and billing accounts contained in the sink's parent resource
+ // are also available for export. Whether a particular log entry from
+ // the children is exported depends on the sink's filter expression. For
// example, if this field is true, then the filter
// resource.type=gce_instance would export all Compute Engine VM
// instance log entries from all projects in the sink's parent. To only
// export entries from certain child projects, filter on the project
// part of the log name:
- // logName:("projects/test-project-a/" OR "projects/test-project-b/")
+ // logName:("projects/test-project1/" OR "projects/test-project2/")
// AND
// resource.type=gce_instance
//
diff --git a/logging/v2beta1/logging-api.json b/logging/v2beta1/logging-api.json
index f9a8537..3419f22 100644
--- a/logging/v2beta1/logging-api.json
+++ b/logging/v2beta1/logging-api.json
@@ -1,43 +1,161 @@
{
- "ownerName": "Google",
"resources": {
- "projects": {
+ "organizations": {
"resources": {
"logs": {
"methods": {
"delete": {
- "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.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"logName"
],
- "parameters": {
- "logName": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/logs/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}",
- "id": "logging.projects.logs.delete",
- "path": "v2beta1/{+logName}",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
+ "httpMethod": "DELETE"
},
"list": {
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ListLogsResponse"
},
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/organizations/{organizationsId}/logs",
+ "id": "logging.organizations.logs.list",
+ "path": "v2beta1/{+parent}/logs"
+ }
+ }
+ }
+ }
+ },
+ "entries": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {},
+ "flatPath": "v2beta1/entries:list",
+ "path": "v2beta1/entries:list",
+ "id": "logging.entries.list",
+ "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
+ "request": {
+ "$ref": "ListLogEntriesRequest"
+ }
+ },
+ "write": {
+ "path": "v2beta1/entries:write",
+ "id": "logging.entries.write",
+ "description": "Writes log entries to Stackdriver Logging.",
+ "request": {
+ "$ref": "WriteLogEntriesRequest"
+ },
+ "response": {
+ "$ref": "WriteLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {},
+ "flatPath": "v2beta1/entries:write"
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "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": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2beta1/{+metricName}",
+ "id": "logging.projects.metrics.delete",
+ "description": "Deletes a logs-based metric."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListLogMetricsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -46,78 +164,313 @@
"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": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
"parent": {
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/metrics",
+ "path": "v2beta1/{+parent}/metrics",
+ "id": "logging.projects.metrics.list",
+ "description": "Lists logs-based metrics."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "parameters": {
+ "metricName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.get",
+ "path": "v2beta1/{+metricName}",
+ "description": "Gets a logs-based metric."
+ },
+ "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": {
+ "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ]
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "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"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32"
}
},
- "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."
+ "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."
}
}
},
- "sinks": {
+ "logs": {
"methods": {
- "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.",
+ "delete": {
"response": {
- "$ref": "LogSink"
+ "$ref": "Empty"
},
"parameterOrder": [
- "sinkName"
+ "logName"
],
- "httpMethod": "PUT",
+ "httpMethod": "DELETE",
"parameters": {
- "sinkName": {
+ "logName": {
+ "pattern": "^projects/[^/]+/logs/[^/]+$",
"location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "description": "Required. The resource name of the 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/[^/]+/sinks/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
- "type": "boolean",
- "location": "query"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
- "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2beta1/{+sinkName}",
- "id": "logging.projects.sinks.update"
+ "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."
},
- "create": {
+ "list": {
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
"parameters": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
"parent": {
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/logs",
+ "path": "v2beta1/{+parent}/logs",
+ "id": "logging.projects.logs.list"
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "list": {
+ "description": "Lists sinks.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^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"
+ }
+ },
+ "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",
+ "id": "logging.projects.sinks.list",
+ "path": "v2beta1/{+parent}/sinks"
+ },
+ "get": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2beta1/{+sinkName}",
+ "id": "logging.projects.sinks.get",
+ "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": "^projects/[^/]+/sinks/[^/]+$",
"location": "path"
},
"uniqueWriterIdentity": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false."
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.update",
+ "path": "v2beta1/{+sinkName}"
+ },
+ "create": {
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the 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.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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"
@@ -128,35 +481,10 @@
"https://www.googleapis.com/auth/logging.admin"
],
"flatPath": "v2beta1/projects/{projectsId}/sinks",
- "id": "logging.projects.sinks.create",
"path": "v2beta1/{+parent}/sinks",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the 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"
- }
+ "id": "logging.projects.sinks.create"
},
"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.",
@@ -166,232 +494,21 @@
"parameterOrder": [
"sinkName"
],
- "httpMethod": "DELETE"
- },
- "list": {
- "id": "logging.projects.sinks.list",
- "path": "v2beta1/{+parent}/sinks",
- "description": "Lists sinks.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListSinksResponse"
- },
+ "httpMethod": "DELETE",
"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"
+ "https://www.googleapis.com/auth/logging.admin"
],
"parameters": {
- "parent": {
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/sinks"
- },
- "get": {
- "description": "Gets a sink.",
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
"sinkName": {
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "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}"
- }
- }
- },
- "metrics": {
- "methods": {
- "list": {
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListLogMetricsResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "parameters": {
- "metricName": {
"location": "path",
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "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/[^/]+/metrics/[^/]+$"
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.get",
- "path": "v2beta1/{+metricName}"
- },
- "update": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "metricName": {
- "location": "path",
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2beta1/{+metricName}",
- "id": "logging.projects.metrics.update",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates or updates a logs-based metric."
- },
- "create": {
- "flatPath": "v2beta1/projects/{projectsId}/metrics",
- "path": "v2beta1/{+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/[^/]+$"
- }
- }
- },
- "delete": {
- "description": "Deletes a logs-based metric.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "metricName": {
- "location": "path",
- "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2beta1/{+metricName}",
- "id": "logging.projects.metrics.delete"
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}"
}
}
}
@@ -402,40 +519,49 @@
"logs": {
"methods": {
"delete": {
+ "path": "v2beta1/{+logName}",
+ "id": "logging.billingAccounts.logs.delete",
"description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"logName"
],
"httpMethod": "DELETE",
- "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"
- }
+ "response": {
+ "$ref": "Empty"
},
"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"
+ "parameters": {
+ "logName": {
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/logs/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}"
},
"list": {
+ "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs",
+ "id": "logging.billingAccounts.logs.list",
+ "path": "v2beta1/{+parent}/logs",
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "parameterOrder": [
- "parent"
- ],
+ "httpMethod": "GET",
"response": {
"$ref": "ListLogsResponse"
},
- "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
"parameters": {
"parent": {
"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",
@@ -455,16 +581,7 @@
"format": "int32",
"type": "integer"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs",
- "path": "v2beta1/{+parent}/logs",
- "id": "logging.billingAccounts.logs.list"
+ }
}
}
}
@@ -473,10 +590,14 @@
"monitoredResourceDescriptors": {
"methods": {
"list": {
- "parameterOrder": [],
+ "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",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -485,149 +606,58 @@
"https://www.googleapis.com/auth/logging.read"
],
"parameters": {
- "pageSize": {
+ "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"
- },
- "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",
+ "type": "integer",
"location": "query"
}
- },
- "flatPath": "v2beta1/monitoredResourceDescriptors",
- "path": "v2beta1/monitoredResourceDescriptors",
- "id": "logging.monitoredResourceDescriptors.list",
- "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
- }
- }
- },
- "organizations": {
- "resources": {
- "logs": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "parameters": {
- "logName": {
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/logs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "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",
- "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": {
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v2beta1/organizations/{organizationsId}/logs",
- "path": "v2beta1/{+parent}/logs",
- "id": "logging.organizations.logs.list"
- }
}
}
}
- },
- "entries": {
- "methods": {
- "list": {
- "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
- "request": {
- "$ref": "ListLogEntriesRequest"
- },
- "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"
- },
- "write": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2beta1/entries:write",
- "path": "v2beta1/entries:write",
- "id": "logging.entries.write",
- "request": {
- "$ref": "WriteLogEntriesRequest"
- },
- "description": "Writes log entries to Stackdriver Logging.",
- "response": {
- "$ref": "WriteLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- }
- }
}
},
"parameters": {
- "upload_protocol": {
- "type": "string",
+ "access_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "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",
@@ -645,31 +675,25 @@
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -677,52 +701,153 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string"
- },
- "key": {
- "description": "API key. Your API 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": {
- "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": "v2beta1",
"baseUrl": "https://logging.googleapis.com/",
+ "description": "Writes log entries and manages your Stackdriver Logging configuration.",
"kind": "discovery#restDescription",
"servicePath": "",
- "description": "Writes log entries and manages your Stackdriver Logging configuration.",
"basePath": "",
"id": "logging:v2beta1",
"documentationLink": "https://cloud.google.com/logging/docs/",
- "revision": "20170429",
+ "revision": "20170530",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "SourceReference": {
+ "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
+ "type": "object",
+ "properties": {
+ "repository": {
+ "type": "string",
+ "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\""
+ },
+ "revisionId": {
+ "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
+ "type": "string"
+ }
+ },
+ "id": "SourceReference"
+ },
+ "WriteLogEntriesResponse": {
+ "id": "WriteLogEntriesResponse",
+ "description": "Result returned from WriteLogEntries. empty",
+ "type": "object",
+ "properties": {}
+ },
+ "LogEntryOperation": {
+ "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
+ "type": "string"
+ },
+ "producer": {
+ "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
+ "type": "string"
+ },
+ "first": {
+ "description": "Optional. Set this to True if this is the first log entry in the operation.",
+ "type": "boolean"
+ },
+ "last": {
+ "description": "Optional. Set this to True if this is the last log entry in the operation.",
+ "type": "boolean"
+ }
+ },
+ "id": "LogEntryOperation"
+ },
+ "LogMetric": {
+ "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "LogMetric"
+ },
+ "MonitoredResource": {
+ "id": "MonitoredResource",
+ "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
+ "type": "object"
+ },
+ "type": {
+ "type": "string",
+ "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance."
+ }
+ }
+ },
+ "WriteLogEntriesRequest": {
+ "description": "The parameters to WriteLogEntries.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry."
+ },
+ "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"
+ }
+ }
+ },
+ "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",
@@ -732,17 +857,17 @@
"type": "string"
},
"includeChildren": {
- "description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are availble for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project-a/\" OR \"projects/test-project-b/\") AND\nresource.type=gce_instance\n",
+ "description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND\nresource.type=gce_instance\n",
"type": "boolean"
},
- "destination": {
- "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",
"type": "string"
},
+ "destination": {
+ "type": "string",
+ "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks."
+ },
"endTime": {
"description": "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",
@@ -758,104 +883,44 @@
"type": "string"
},
"outputVersionFormat": {
+ "enumDescriptions": [
+ "An unspecified format version that will default to V2.",
+ "LogEntry version 2 format.",
+ "LogEntry version 1 format."
+ ],
"enum": [
"VERSION_FORMAT_UNSPECIFIED",
"V2",
"V1"
],
"description": "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."
- ]
+ "type": "string"
}
},
"id": "LogSink"
},
- "WriteLogEntriesRequest": {
- "id": "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 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": {
- "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "resource": {
- "$ref": "MonitoredResource",
- "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry."
- }
- }
- },
"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"
}
}
},
- "ListSinksResponse": {
- "description": "Result returned from ListSinks.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.",
- "type": "string"
- },
- "sinks": {
- "description": "A list of sinks.",
- "type": "array",
- "items": {
- "$ref": "LogSink"
- }
- }
- },
- "id": "ListSinksResponse"
- },
"HttpRequest": {
- "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": {
- "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"
@@ -874,14 +939,14 @@
"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"
+ "format": "google-duration",
+ "type": "string"
},
"cacheFillBytes": {
- "type": "string",
"description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"requestMethod": {
"description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
@@ -893,13 +958,13 @@
"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"
+ "format": "int64",
+ "type": "string"
},
"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\"."
+ "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.",
@@ -908,27 +973,40 @@
"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"
}
- }
+ },
+ "id": "HttpRequest"
+ },
+ "ListSinksResponse": {
+ "description": "Result returned from ListSinks.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken."
+ },
+ "sinks": {
+ "description": "A list of sinks.",
+ "type": "array",
+ "items": {
+ "$ref": "LogSink"
+ }
+ }
+ },
+ "id": "ListSinksResponse"
},
"LabelDescriptor": {
"description": "A description of a label.",
"type": "object",
"properties": {
- "valueType": {
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
- ],
- "description": "The type of data that can be assigned to the label.",
- "type": "string",
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ]
- },
"key": {
"description": "The label key.",
"type": "string"
@@ -936,6 +1014,20 @@
"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"
@@ -944,6 +1036,13 @@
"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": {
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\"."
+ },
"name": {
"description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".",
"type": "string"
@@ -959,90 +1058,52 @@
"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": {
+ "id": "LogEntrySourceLocation",
"description": "Additional information about the source code location that produced the log entry.",
"type": "object",
"properties": {
- "line": {
- "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
- "format": "int64",
+ "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": {
+ "type": "string",
+ "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
+ "format": "int64"
+ },
"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)."
}
- },
- "id": "LogEntrySourceLocation"
+ }
},
"ListLogEntriesResponse": {
"description": "Result returned from ListLogEntries.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.",
- "type": "string"
- },
"entries": {
"description": "A list of log entries.",
"type": "array",
"items": {
"$ref": "LogEntry"
}
+ },
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.",
+ "type": "string"
}
},
"id": "ListLogEntriesResponse"
},
"LogLine": {
- "id": "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": {
"$ref": "SourceLocation",
"description": "Where in the source code this log message was written."
@@ -1051,69 +1112,9 @@
"description": "Approximate time when this log entry was made.",
"format": "google-datetime",
"type": "string"
- }
- }
- },
- "ListLogMetricsResponse": {
- "id": "ListLogMetricsResponse",
- "description": "Result returned from ListLogMetrics.",
- "type": "object",
- "properties": {
- "metrics": {
- "description": "A list of logs-based metrics.",
- "type": "array",
- "items": {
- "$ref": "LogMetric"
- }
- },
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- }
- }
- },
- "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 {}."
- },
- "LogEntry": {
- "description": "An individual entry in a log.",
- "type": "object",
- "properties": {
- "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": {
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "trace": {
- "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824",
- "type": "string"
},
"severity": {
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ],
- "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
+ "description": "Severity of this log entry.",
"type": "string",
"enumDescriptions": [
"(0) The log entry has no assigned severity level.",
@@ -1125,11 +1126,58 @@
"(600) Critical events cause more severe problems or outages.",
"(700) A person must take an action immediately.",
"(800) One or more systems are unusable."
+ ],
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
]
},
- "sourceLocation": {
- "$ref": "LogEntrySourceLocation",
- "description": "Optional. Source code location information associated with the log entry, if any."
+ "logMessage": {
+ "description": "App-provided log message.",
+ "type": "string"
+ }
+ },
+ "id": "LogLine"
+ },
+ "ListLogMetricsResponse": {
+ "description": "Result returned from ListLogMetrics.",
+ "type": "object",
+ "properties": {
+ "metrics": {
+ "type": "array",
+ "items": {
+ "$ref": "LogMetric"
+ },
+ "description": "A list of logs-based metrics."
+ },
+ "nextPageToken": {
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
+ "type": "string"
+ }
+ },
+ "id": "ListLogMetricsResponse"
+ },
+ "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": {
+ "receiveTimestamp": {
+ "description": "Output only. The time the log entry was received by Stackdriver Logging.",
+ "format": "google-datetime",
+ "type": "string"
},
"timestamp": {
"description": "Optional. The time the event described by the log entry occurred. 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.",
@@ -1140,14 +1188,14 @@
"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": {
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.",
+ "$ref": "HttpRequest"
+ },
"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.",
@@ -1156,22 +1204,73 @@
"description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
"type": "object"
},
- "insertId": {
- "description": "Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value.",
- "type": "string"
- },
"operation": {
"$ref": "LogEntryOperation",
"description": "Optional. Information about an operation associated with the log entry, if applicable."
},
+ "insertId": {
+ "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": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
+ "type": "object"
+ },
+ "trace": {
+ "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "severity": {
+ "type": "string",
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ],
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ],
+ "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT."
+ },
+ "sourceLocation": {
+ "$ref": "LogEntrySourceLocation",
+ "description": "Optional. Source code location information associated with the log entry, if any."
}
},
"id": "LogEntry"
},
"SourceLocation": {
+ "description": "Specifies a location in a source code file.",
+ "type": "object",
"properties": {
"file": {
"description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
@@ -1187,14 +1286,25 @@
"type": "string"
}
},
- "id": "SourceLocation",
- "description": "Specifies a location in a source code file.",
- "type": "object"
+ "id": "SourceLocation"
},
"ListLogEntriesRequest": {
"description": "The parameters to ListLogEntries.",
"type": "object",
"properties": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
+ "type": "string"
+ },
"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",
@@ -1212,19 +1322,6 @@
"items": {
"type": "string"
}
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "orderBy": {
- "type": "string",
- "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values."
}
},
"id": "ListLogEntriesRequest"
@@ -1233,11 +1330,36 @@
"description": "Complete log information about a single HTTP request to an App Engine application.",
"type": "object",
"properties": {
- "megaCycles": {
- "description": "Number of CPU megacycles used to process request.",
- "format": "int64",
+ "ip": {
+ "type": "string",
+ "description": "Origin IP address."
+ },
+ "appId": {
+ "description": "Application that handled this request.",
"type": "string"
},
+ "appEngineRelease": {
+ "description": "App Engine release version.",
+ "type": "string"
+ },
+ "method": {
+ "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
+ "type": "string"
+ },
+ "cost": {
+ "description": "An indication of the relative cost of serving this request.",
+ "format": "double",
+ "type": "number"
+ },
+ "instanceId": {
+ "description": "An identifier for the instance that handled the request.",
+ "type": "string"
+ },
+ "megaCycles": {
+ "type": "string",
+ "description": "Number of CPU megacycles used to process request.",
+ "format": "int64"
+ },
"first": {
"description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
"type": "boolean"
@@ -1251,17 +1373,17 @@
"type": "string"
},
"endTime": {
- "type": "string",
"description": "Time when the request finished.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"userAgent": {
"description": "User agent that made the request.",
"type": "string"
},
"wasLoadingRequest": {
- "description": "Whether this was a loading request for the instance.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether this was a loading request for the instance."
},
"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.",
@@ -1280,20 +1402,20 @@
"type": "string"
},
"line": {
+ "description": "A list of log lines emitted by the application while serving this request.",
"type": "array",
"items": {
"$ref": "LogLine"
- },
- "description": "A list of log lines emitted by the application while serving this request."
- },
- "referrer": {
- "description": "Referrer URL of request.",
- "type": "string"
+ }
},
"taskQueueName": {
"description": "Queue name of the request, in the case of an offline request.",
"type": "string"
},
+ "referrer": {
+ "description": "Referrer URL of request.",
+ "type": "string"
+ },
"requestId": {
"description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.",
"type": "string"
@@ -1321,22 +1443,22 @@
"type": "string"
},
"urlMapEntry": {
- "type": "string",
- "description": "File or class that handled the request."
+ "description": "File or class that handled the request.",
+ "type": "string"
},
"instanceIndex": {
- "type": "integer",
"description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
+ },
+ "finished": {
+ "type": "boolean",
+ "description": "Whether this request is finished or active."
},
"host": {
"description": "Internet host and port number of the resource being requested.",
"type": "string"
},
- "finished": {
- "description": "Whether this request is finished or active.",
- "type": "boolean"
- },
"httpVersion": {
"description": "HTTP version of request. Example: \"HTTP/1.1\".",
"type": "string"
@@ -1347,39 +1469,16 @@
"type": "string"
},
"latency": {
+ "type": "string",
"description": "Latency of the request.",
- "format": "google-duration",
- "type": "string"
- },
- "ip": {
- "description": "Origin IP address.",
- "type": "string"
- },
- "appId": {
- "description": "Application that handled this request.",
- "type": "string"
- },
- "appEngineRelease": {
- "description": "App Engine release version.",
- "type": "string"
- },
- "method": {
- "type": "string",
- "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\"."
- },
- "cost": {
- "description": "An indication of the relative cost of serving this request.",
- "format": "double",
- "type": "number"
- },
- "instanceId": {
- "type": "string",
- "description": "An identifier for the instance that handled the request."
+ "format": "google-duration"
}
},
"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.",
@@ -1393,102 +1492,7 @@
}
}
},
- "id": "ListMonitoredResourceDescriptorsResponse",
- "description": "Result returned from ListMonitoredResourceDescriptors.",
- "type": "object"
- },
- "SourceReference": {
- "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
- "type": "object",
- "properties": {
- "repository": {
- "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
- "type": "string"
- },
- "revisionId": {
- "type": "string",
- "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\""
- }
- },
- "id": "SourceReference"
- },
- "WriteLogEntriesResponse": {
- "description": "Result returned from WriteLogEntries. empty",
- "type": "object",
- "properties": {},
- "id": "WriteLogEntriesResponse"
- },
- "LogMetric": {
- "id": "LogMetric",
- "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.",
- "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": {
- "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."
- ],
- "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"
- }
- }
- },
- "LogEntryOperation": {
- "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
- "type": "object",
- "properties": {
- "last": {
- "description": "Optional. Set this to True if this is the last log entry in the operation.",
- "type": "boolean"
- },
- "id": {
- "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
- "type": "string"
- },
- "producer": {
- "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": {
- "description": "Optional. Set this to True if this is the first log entry in the operation.",
- "type": "boolean"
- }
- },
- "id": "LogEntryOperation"
- },
- "MonitoredResource": {
- "id": "MonitoredResource",
- "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
- "type": "object"
- },
- "type": {
- "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
- "type": "string"
- }
- }
+ "id": "ListMonitoredResourceDescriptorsResponse"
}
},
"icons": {
@@ -1522,5 +1526,6 @@
"ownerDomain": "google.com",
"name": "logging",
"batchPath": "batch",
- "title": "Stackdriver Logging API"
+ "title": "Stackdriver Logging API",
+ "ownerName": "Google"
}
diff --git a/logging/v2beta1/logging-gen.go b/logging/v2beta1/logging-gen.go
index 6995010..aba4e9a 100644
--- a/logging/v2beta1/logging-gen.go
+++ b/logging/v2beta1/logging-gen.go
@@ -670,6 +670,10 @@
// log entry payloads.
ProtoPayload googleapi.RawMessage `json:"protoPayload,omitempty"`
+ // ReceiveTimestamp: Output only. The time the log entry was received by
+ // Stackdriver Logging.
+ ReceiveTimestamp string `json:"receiveTimestamp,omitempty"`
+
// Resource: 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
@@ -975,17 +979,17 @@
// IncludeChildren: Optional. This field applies only to sinks owned by
// organizations and folders. If the field is false, the default, only
- // the logs owned by the sink's parent resource are availble for export.
- // If the field is true, then logs from all the projects, folders, and
- // billing accounts contained in the sink's parent resource are also
- // available for export. Whether a particular log entry from the
- // children is exported depends on the sink's filter expression. For
+ // the logs owned by the sink's parent resource are available for
+ // export. If the field is true, then logs from all the projects,
+ // folders, and billing accounts contained in the sink's parent resource
+ // are also available for export. Whether a particular log entry from
+ // the children is exported depends on the sink's filter expression. For
// example, if this field is true, then the filter
// resource.type=gce_instance would export all Compute Engine VM
// instance log entries from all projects in the sink's parent. To only
// export entries from certain child projects, filter on the project
// part of the log name:
- // logName:("projects/test-project-a/" OR "projects/test-project-b/")
+ // logName:("projects/test-project1/" OR "projects/test-project2/")
// AND
// resource.type=gce_instance
//
diff --git a/manufacturers/v1/manufacturers-api.json b/manufacturers/v1/manufacturers-api.json
index 222efe8..d25e6cb 100644
--- a/manufacturers/v1/manufacturers-api.json
+++ b/manufacturers/v1/manufacturers-api.json
@@ -1,31 +1,194 @@
{
+ "name": "manufacturers",
+ "batchPath": "batch",
+ "title": "Manufacturer Center API",
+ "ownerName": "Google",
+ "resources": {
+ "accounts": {
+ "resources": {
+ "products": {
+ "methods": {
+ "list": {
+ "description": "Lists all the products in a Manufacturer Center account.",
+ "response": {
+ "$ref": "ListProductsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum number of product statuses to return in the response, used for\npaging.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "required": true,
+ "type": "string",
+ "pattern": "^accounts/[^/]+$"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products",
+ "path": "v1/{+parent}/products",
+ "id": "manufacturers.accounts.products.list"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent",
+ "name"
+ ],
+ "response": {
+ "$ref": "Product"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "id": "manufacturers.accounts.products.get",
+ "path": "v1/{+parent}/products/{+name}",
+ "description": "Gets the product from a Manufacturer Center account, including product\nissues."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "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"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://manufacturers.googleapis.com/",
+ "servicePath": "",
+ "description": "Public API for managing Manufacturer Center related data.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "manufacturers:v1",
"revision": "20170412",
"documentationLink": "https://developers.google.com/manufacturers/",
- "id": "manufacturers:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "ListProductsResponse": {
- "type": "object",
- "properties": {
- "products": {
- "description": "List of the products.",
- "type": "array",
- "items": {
- "$ref": "Product"
- }
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of product statuses.",
- "type": "string"
- }
- },
- "id": "ListProductsResponse"
- },
"ProductDetail": {
- "description": "A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
"type": "object",
"properties": {
+ "attributeValue": {
+ "description": "The value of the attribute.",
+ "type": "string"
+ },
"sectionName": {
"description": "A short section name that can be reused between multiple product details.",
"type": "string"
@@ -33,13 +196,10 @@
"attributeName": {
"description": "The name of the attribute.",
"type": "string"
- },
- "attributeValue": {
- "description": "The value of the attribute.",
- "type": "string"
}
},
- "id": "ProductDetail"
+ "id": "ProductDetail",
+ "description": "A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail."
},
"Issue": {
"description": "Product issue.",
@@ -55,12 +215,6 @@
"type": "string"
},
"severity": {
- "enum": [
- "SEVERITY_UNSPECIFIED",
- "ERROR",
- "WARNING",
- "INFO"
- ],
"description": "The severity of the issue.",
"type": "string",
"enumDescriptions": [
@@ -68,6 +222,12 @@
"Error severity. The issue prevents the usage of the whole item.",
"Warning severity. The issue is either one that prevents the usage of the\nattribute that triggered it or one that will soon prevent the usage of\nthe whole item.",
"Info severity. The issue is one that doesn't require immediate attention.\nIt is, for example, used to communicate which attributes are still\npending review."
+ ],
+ "enum": [
+ "SEVERITY_UNSPECIFIED",
+ "ERROR",
+ "WARNING",
+ "INFO"
]
},
"description": {
@@ -85,16 +245,16 @@
"description": "A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
"type": "object",
"properties": {
- "text": {
- "description": "A detailed description of the feature.",
- "type": "string"
- },
"image": {
- "description": "An optional image describing the feature.",
- "$ref": "Image"
+ "$ref": "Image",
+ "description": "An optional image describing the feature."
},
"headline": {
- "description": "A short description of the feature.",
+ "type": "string",
+ "description": "A short description of the feature."
+ },
+ "text": {
+ "description": "A detailed description of the feature.",
"type": "string"
}
},
@@ -104,19 +264,39 @@
"description": "A price.",
"type": "object",
"properties": {
- "currency": {
- "description": "The currency in which the price is denoted.",
- "type": "string"
- },
"amount": {
"description": "The numeric value of the price.",
"type": "string"
+ },
+ "currency": {
+ "description": "The currency in which the price is denoted.",
+ "type": "string"
}
},
"id": "Price"
},
"Image": {
+ "description": "An image.",
+ "type": "object",
"properties": {
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "Type is unspecified. Should not be used.",
+ "The image was crawled from a provided URL.",
+ "The image was uploaded."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CRAWLED",
+ "UPLOADED"
+ ],
+ "description": "The type of the image, i.e., crawled or uploaded.\n@OutputOnly"
+ },
+ "imageUrl": {
+ "description": "The URL of the image. For crawled images, this is the provided URL. For\nuploaded images, this is a serving URL from Google if the image has been\nprocessed successfully.",
+ "type": "string"
+ },
"status": {
"enumDescriptions": [
"Status is unspecified. Should not be used.",
@@ -146,35 +326,92 @@
],
"description": "The status of the image.\n@OutputOnly",
"type": "string"
- },
- "type": {
- "enumDescriptions": [
- "Type is unspecified. Should not be used.",
- "The image was crawled from a provided URL.",
- "The image was uploaded."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "CRAWLED",
- "UPLOADED"
- ],
- "description": "The type of the image, i.e., crawled or uploaded.\n@OutputOnly",
- "type": "string"
- },
- "imageUrl": {
- "type": "string",
- "description": "The URL of the image. For crawled images, this is the provided URL. For\nuploaded images, this is a serving URL from Google if the image has been\nprocessed successfully."
}
},
- "id": "Image",
- "description": "An image.",
- "type": "object"
+ "id": "Image"
},
"Attributes": {
"id": "Attributes",
"description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
"type": "object",
"properties": {
+ "flavor": {
+ "description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.",
+ "type": "string"
+ },
+ "productDetail": {
+ "description": "The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
+ "type": "array",
+ "items": {
+ "$ref": "ProductDetail"
+ }
+ },
+ "ageGroup": {
+ "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.",
+ "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": {
+ "type": "string",
+ "description": "The URL of the detail page of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage."
+ },
+ "releaseDate": {
+ "description": "The release date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#release.",
+ "type": "string"
+ },
+ "itemGroupId": {
+ "description": "The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid.",
+ "type": "string"
+ },
+ "gtin": {
+ "description": "The Global Trade Item Number (GTIN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#gtin.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "productLine": {
+ "description": "The name of the group of products related to the product. For more\ninformation, see\nhttps://support.google.com/manufacturers/answer/6124116#productline.",
+ "type": "string"
+ },
+ "capacity": {
+ "description": "The capacity of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
+ "$ref": "Capacity"
+ },
+ "description": {
+ "description": "The description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#description.",
+ "type": "string"
+ },
+ "gender": {
+ "description": "The target gender of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#gender.",
+ "type": "string"
+ },
+ "sizeSystem": {
+ "description": "The size system of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizesystem.",
+ "type": "string"
+ },
+ "theme": {
+ "description": "The theme of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#theme.",
+ "type": "string"
+ },
+ "pattern": {
+ "description": "The pattern of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#pattern.",
+ "type": "string"
+ },
+ "imageLink": {
+ "$ref": "Image",
+ "description": "The image of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#image."
+ },
+ "productType": {
+ "description": "The category of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#producttype.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"format": {
"description": "The format of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#format.",
"type": "string"
@@ -217,114 +454,36 @@
}
},
"size": {
- "type": "string",
- "description": "The size of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#size."
+ "description": "The size of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#size.",
+ "type": "string"
},
"title": {
"type": "string",
"description": "The title of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#title."
},
"count": {
- "$ref": "Count",
- "description": "The count of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count."
+ "description": "The count of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.",
+ "$ref": "Count"
},
"brand": {
"description": "The brand name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#brand.",
"type": "string"
},
+ "material": {
+ "description": "The material of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#material.",
+ "type": "string"
+ },
"disclosureDate": {
"description": "The disclosure date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#disclosure.",
"type": "string"
},
- "material": {
- "type": "string",
- "description": "The material of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#material."
- },
"scent": {
"description": "The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.",
"type": "string"
- },
- "ageGroup": {
- "type": "string",
- "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup."
- },
- "productDetail": {
- "description": "The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
- "type": "array",
- "items": {
- "$ref": "ProductDetail"
- }
- },
- "flavor": {
- "description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.",
- "type": "string"
- },
- "mpn": {
- "description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.",
- "type": "string"
- },
- "productPageUrl": {
- "type": "string",
- "description": "The URL of the detail page of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage."
- },
- "releaseDate": {
- "type": "string",
- "description": "The release date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#release."
- },
- "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",
- "items": {
- "type": "string"
- }
- },
- "itemGroupId": {
- "description": "The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid.",
- "type": "string"
- },
- "productLine": {
- "description": "The name of the group of products related to the product. For more\ninformation, see\nhttps://support.google.com/manufacturers/answer/6124116#productline.",
- "type": "string"
- },
- "capacity": {
- "$ref": "Capacity",
- "description": "The capacity of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity."
- },
- "description": {
- "type": "string",
- "description": "The description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#description."
- },
- "gender": {
- "description": "The target gender of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#gender.",
- "type": "string"
- },
- "sizeSystem": {
- "description": "The size system of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizesystem.",
- "type": "string"
- },
- "theme": {
- "description": "The theme of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#theme.",
- "type": "string"
- },
- "pattern": {
- "description": "The pattern of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#pattern.",
- "type": "string"
- },
- "imageLink": {
- "description": "The image of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#image.",
- "$ref": "Image"
- },
- "productType": {
- "description": "The category of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#producttype.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
}
},
"Count": {
- "description": "The number of products in a single package. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.",
"type": "object",
"properties": {
"value": {
@@ -337,30 +496,16 @@
"type": "string"
}
},
- "id": "Count"
+ "id": "Count",
+ "description": "The number of products in a single package. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count."
},
"Product": {
- "id": "Product",
"description": "Product data.",
"type": "object",
"properties": {
- "issues": {
- "description": "A server-generated list of issues associated with the product.\n@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "Issue"
- }
- },
- "manuallyDeletedAttributes": {
- "description": "Names of the attributes of the product deleted manually via the\nManufacturer Center UI.\n@OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"finalAttributes": {
- "$ref": "Attributes",
- "description": "Final attributes of the product. The final attributes are obtained by\noverriding the uploaded attributes with the manually provided and deleted\nattributes. Google systems only process, evaluate, review, and/or use final\nattributes.\n@OutputOnly"
+ "description": "Final attributes of the product. The final attributes are obtained by\noverriding the uploaded attributes with the manually provided and deleted\nattributes. Google systems only process, evaluate, review, and/or use final\nattributes.\n@OutputOnly",
+ "$ref": "Attributes"
},
"productId": {
"description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
@@ -387,12 +532,28 @@
"type": "string"
},
"name": {
- "type": "string",
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly"
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
+ "type": "string"
+ },
+ "manuallyDeletedAttributes": {
+ "description": "Names of the attributes of the product deleted manually via the\nManufacturer Center UI.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "issues": {
+ "description": "A server-generated list of issues associated with the product.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "Issue"
+ }
}
- }
+ },
+ "id": "Product"
},
"Capacity": {
+ "id": "Capacity",
"description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
"type": "object",
"properties": {
@@ -402,18 +563,34 @@
"type": "string"
},
"unit": {
- "type": "string",
- "description": "The unit of the capacity, i.e., MB, GB, or TB."
+ "description": "The unit of the capacity, i.e., MB, GB, or TB.",
+ "type": "string"
+ }
+ }
+ },
+ "ListProductsResponse": {
+ "type": "object",
+ "properties": {
+ "products": {
+ "description": "List of the products.",
+ "type": "array",
+ "items": {
+ "$ref": "Product"
+ }
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of product statuses.",
+ "type": "string"
}
},
- "id": "Capacity"
+ "id": "ListProductsResponse"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"canonicalName": "Manufacturer Center",
"auth": {
"oauth2": {
@@ -425,182 +602,5 @@
}
},
"rootUrl": "https://manufacturers.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "manufacturers",
- "batchPath": "batch",
- "title": "Manufacturer Center API",
- "ownerName": "Google",
- "resources": {
- "accounts": {
- "resources": {
- "products": {
- "methods": {
- "list": {
- "description": "Lists all the products in a Manufacturer Center account.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListProductsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "required": true,
- "type": "string",
- "pattern": "^accounts/[^/]+$"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "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"
- }
- },
- "flatPath": "v1/accounts/{accountsId}/products",
- "id": "manufacturers.accounts.products.list",
- "path": "v1/{+parent}/products"
- },
- "get": {
- "path": "v1/{+parent}/products/{+name}",
- "id": "manufacturers.accounts.products.get",
- "description": "Gets the product from a Manufacturer Center account, including product\nissues.",
- "response": {
- "$ref": "Product"
- },
- "parameterOrder": [
- "parent",
- "name"
- ],
- "httpMethod": "GET",
- "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"
- }
- },
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "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"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API 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": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://manufacturers.googleapis.com/",
- "servicePath": "",
- "description": "Public API for managing Manufacturer Center related data.",
- "kind": "discovery#restDescription",
- "basePath": ""
+ "ownerDomain": "google.com"
}
diff --git a/ml/v1/ml-api.json b/ml/v1/ml-api.json
index efd8ef2..246c653 100644
--- a/ml/v1/ml-api.json
+++ b/ml/v1/ml-api.json
@@ -1,8 +1,16 @@
{
+ "ownerName": "Google",
"resources": {
"projects": {
"methods": {
"predict": {
+ "flatPath": "v1/projects/{projectsId}: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"
},
@@ -10,48 +18,41 @@
"name"
],
"httpMethod": "POST",
- "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"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}:predict",
- "path": "v1/{+name}:predict",
- "id": "ml.projects.predict",
- "request": {
- "$ref": "GoogleCloudMlV1__PredictRequest"
- },
- "description": "Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION"
+ "parameters": {
+ "name": {
+ "pattern": "^projects/.+$",
+ "location": "path",
+ "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string"
+ }
+ }
},
"getConfig": {
"flatPath": "v1/projects/{projectsId}:getConfig",
- "path": "v1/{+name}:getConfig",
"id": "ml.projects.getConfig",
+ "path": "v1/{+name}:getConfig",
"description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.",
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "GoogleCloudMlV1__GetConfigResponse"
},
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The project name.\n\nAuthorization: requires `Viewer` role on the specified project.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
}
}
}
@@ -59,36 +60,10 @@
"resources": {
"operations": {
"methods": {
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.operations.delete"
- },
"list": {
- "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`.",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"response": {
"$ref": "GoogleLongrunning__ListOperationsResponse"
},
@@ -98,32 +73,33 @@
"httpMethod": "GET",
"parameters": {
"name": {
+ "description": "The name of the operation's parent resource.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the operation collection."
+ "location": "path"
},
"pageToken": {
+ "type": "string",
"location": "query",
- "description": "The standard list page token.",
- "type": "string"
+ "description": "The standard list page token."
},
"pageSize": {
- "location": "query",
"description": "The standard list page size.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}/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.",
@@ -151,45 +127,71 @@
"id": "ml.projects.operations.get"
},
"cancel": {
- "httpMethod": "POST",
+ "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"
+ ],
"parameters": {
"name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/operations/[^/]+$"
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "ml.projects.operations.cancel"
+ },
+ "delete": {
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "response": {
+ "$ref": "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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
- "id": "ml.projects.operations.cancel",
- "path": "v1/{+name}:cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.operations.delete"
}
}
},
"models": {
"methods": {
"delete": {
- "id": "ml.projects.models.delete",
- "path": "v1/{+name}",
"description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete).",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "GoogleLongrunning__Operation"
},
+ "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.",
@@ -199,40 +201,39 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}"
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.delete"
},
"list": {
"response": {
"$ref": "GoogleCloudMlV1__ListModelsResponse"
},
+ "httpMethod": "GET",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
+ "pageToken": {
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "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": {
+ "location": "path",
"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"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
+ "pattern": "^projects/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/models",
@@ -248,28 +249,30 @@
"name"
],
"httpMethod": "GET",
- "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"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the model.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/models/{modelsId}",
"path": "v1/{+name}",
"id": "ml.projects.models.get",
"description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed)."
},
"create": {
+ "path": "v1/{+parent}/models",
+ "id": "ml.projects.models.create",
+ "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create).",
"request": {
"$ref": "GoogleCloudMlV1__Model"
},
- "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create).",
"response": {
"$ref": "GoogleCloudMlV1__Model"
},
@@ -277,6 +280,9 @@
"parent"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"parent": {
"description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
@@ -286,17 +292,98 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models",
- "path": "v1/{+parent}/models",
- "id": "ml.projects.models.create"
+ "flatPath": "v1/projects/{projectsId}/models"
}
},
"resources": {
"versions": {
"methods": {
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.versions.delete",
+ "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version.",
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the version. You can get the names of all the\nversions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__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": {
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "format": "int32"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ "path": "v1/{+parent}/versions",
+ "id": "ml.projects.models.versions.list",
+ "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has 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": {
+ "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "id": "ml.projects.models.versions.get",
+ "path": "v1/{+name}"
+ },
"create": {
"response": {
"$ref": "GoogleLongrunning__Operation"
@@ -307,11 +394,11 @@
"httpMethod": "POST",
"parameters": {
"parent": {
- "location": "path",
"description": "Required. The name of the model.\n\nAuthorization: requires `Editor` role on the parent project.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$"
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -330,114 +417,28 @@
"request": {
"$ref": "GoogleCloudMlV1__SetDefaultVersionRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"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-engine/reference/rest/v1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
- "id": "ml.projects.models.versions.setDefault",
- "path": "v1/{+name}:setDefault"
- },
- "delete": {
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.versions.delete",
- "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version.",
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "httpMethod": "DELETE",
- "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-engine/reference/rest/v1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path"
- }
- }
- },
- "list": {
- "path": "v1/{+parent}/versions",
- "id": "ml.projects.models.versions.list",
- "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has a lot of versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages):",
- "response": {
- "$ref": "GoogleCloudMlV1__ListVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions"
- },
- "get": {
- "response": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path",
- "description": "Required. The name of the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.versions.get",
- "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model."
+ "path": "v1/{+name}:setDefault",
+ "id": "ml.projects.models.versions.setDefault"
}
}
}
@@ -446,34 +447,65 @@
"jobs": {
"methods": {
"cancel": {
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "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"
- }
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the job to cancel.\n\nAuthorization: requires `Editor` role on the parent project."
+ }
+ },
"flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel",
- "path": "v1/{+name}:cancel",
"id": "ml.projects.jobs.cancel",
+ "path": "v1/{+name}:cancel",
+ "description": "Cancels a running job.",
"request": {
"$ref": "GoogleCloudMlV1__CancelJobRequest"
- },
- "description": "Cancels a running job."
+ }
},
"list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "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",
+ "pattern": "^projects/[^/]+$"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs",
+ "path": "v1/{+parent}/jobs",
+ "id": "ml.projects.jobs.list",
"description": "Lists the jobs in the project.",
"response": {
"$ref": "GoogleCloudMlV1__ListJobsResponse"
@@ -481,38 +513,7 @@
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Optional. The number of jobs to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "Required. The name of the project for which to list jobs.\n\nAuthorization: requires `Viewer` role on the specified project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "filter": {
- "location": "query",
- "description": "Optional. Specifies the subset of jobs to retrieve.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs",
- "path": "v1/{+parent}/jobs",
- "id": "ml.projects.jobs.list"
+ "httpMethod": "GET"
},
"get": {
"response": {
@@ -527,11 +528,11 @@
],
"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/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
@@ -540,6 +541,21 @@
"description": "Describes a job."
},
"create": {
+ "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": "v1/projects/{projectsId}/jobs",
+ "path": "v1/{+parent}/jobs",
+ "id": "ml.projects.jobs.create",
"description": "Creates a training or a batch prediction job.",
"request": {
"$ref": "GoogleCloudMlV1__Job"
@@ -550,22 +566,7 @@
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs",
- "path": "v1/{+parent}/jobs",
- "id": "ml.projects.jobs.create"
+ "httpMethod": "POST"
}
}
}
@@ -573,49 +574,14 @@
}
},
"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": {
+ "callback": {
"location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
+ "description": "JSONP",
"type": "string"
},
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -624,16 +590,10 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
+ ]
},
"alt": {
+ "default": "json",
"enum": [
"json",
"media",
@@ -646,8 +606,7 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "description": "Data format for response."
},
"access_token": {
"description": "OAuth access token.",
@@ -655,30 +614,239 @@
"location": "query"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
}
},
"version": "v1",
"baseUrl": "https://ml.googleapis.com/",
- "servicePath": "",
"kind": "discovery#restDescription",
"description": "An API to enable creating and using machine learning models.",
+ "servicePath": "",
"basePath": "",
- "id": "ml:v1",
+ "revision": "20170527",
"documentationLink": "https://cloud.google.com/ml/",
- "revision": "20170509",
+ "id": "ml:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "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"
+ },
+ "extensions": {
+ "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "data": {
+ "description": "HTTP body binary data.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "GoogleApi__HttpBody"
+ },
+ "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-engine/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"
+ },
+ "automaticScaling": {
+ "$ref": "GoogleCloudMlV1beta1__AutomaticScaling",
+ "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes."
+ },
+ "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\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformaiton.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/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.\nThe total number of model files can't exceed 1000.",
+ "type": "string"
+ },
+ "isDefault": {
+ "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).",
+ "type": "boolean"
+ },
+ "createTime": {
+ "description": "Output only. The time the version was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "manualScaling": {
+ "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `automatic_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want predictable\nbilling. Beware that latency and error rates will increase if the\ntraffic exceeds that capability of the system to serve it based on\nthe selected number of nodes.",
+ "$ref": "GoogleCloudMlV1beta1__ManualScaling"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__Version"
+ },
+ "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"
+ }
+ },
+ "id": "GoogleCloudMlV1__GetConfigResponse"
+ },
+ "GoogleCloudMlV1__HyperparameterOutput": {
+ "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": {
+ "type": "string",
+ "description": "The trial id for these results."
+ }
+ },
+ "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."
+ },
+ "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"
+ }
+ },
+ "id": "GoogleCloudMlV1__PredictionOutput"
+ },
+ "GoogleCloudMlV1__AutomaticScaling": {
+ "description": "Options for automatically scaling a model.",
+ "type": "object",
+ "properties": {
+ "minNodes": {
+ "description": "Optional. The minimum number of nodes to allocate for this model. These\nnodes are always up, starting from the time the model is deployed, so the\ncost of operating this model will be at least\n`rate` * `min_nodes` * number of hours since last billing cycle,\nwhere `rate` is the cost per node-hour as documented in\n[pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),\neven if no predictions are performed. There is additional cost for each\nprediction performed.\n\nUnlike manual scaling, if the load gets too heavy for the nodes\nthat are up, the service will automatically add nodes to handle the\nincreased load as well as scale back as traffic drops, always maintaining\nat least `min_nodes`. You will be charged for the time in which additional\nnodes are used.\n\nIf not specified, `min_nodes` defaults to 0, in which case, when traffic\nto a model stops (and after a cool-down period), nodes will be shut down\nand no charges will be incurred until traffic to the model resumes.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1__AutomaticScaling"
+ },
+ "GoogleCloudMlV1beta1__AutomaticScaling": {
+ "description": "Options for automatically scaling a model.",
+ "type": "object",
+ "properties": {
+ "minNodes": {
+ "description": "Optional. The minimum number of nodes to allocate for this model. These\nnodes are always up, starting from the time the model is deployed, so the\ncost of operating this model will be at least\n`rate` * `min_nodes` * number of hours since last billing cycle,\nwhere `rate` is the cost per node-hour as documented in\n[pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),\neven if no predictions are performed. There is additional cost for each\nprediction performed.\n\nUnlike manual scaling, if the load gets too heavy for the nodes\nthat are up, the service will automatically add nodes to handle the\nincreased load as well as scale back as traffic drops, always maintaining\nat least `min_nodes`. You will be charged for the time in which additional\nnodes are used.\n\nIf not specified, `min_nodes` defaults to 0, in which case, when traffic\nto a model stops (and after a cool-down period), nodes will be shut down\nand no charges will be incurred until traffic to the model resumes.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__AutomaticScaling"
+ },
"GoogleLongrunning__ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
+ "type": "string",
+ "description": "The standard List next-page token."
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
@@ -695,7 +863,7 @@
"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.",
+ "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to `nodes` * number of hours since\nlast billing cycle plus the cost for each prediction performed.",
"format": "int32",
"type": "integer"
}
@@ -706,26 +874,26 @@
"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"
+ "type": "boolean",
+ "description": "Whether this job is a hyperparameter tuning job."
},
"consumedMLUnits": {
"description": "The amount of ML units consumed by the job.",
"format": "double",
"type": "number"
+ },
+ "trials": {
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__HyperparameterOutput"
+ },
+ "description": "Results for individual Hyperparameter trials.\nOnly set for hyperparameter tuning jobs."
}
},
"id": "GoogleCloudMlV1__TrainingOutput"
@@ -742,38 +910,29 @@
"id": "GoogleCloudMlV1__PredictRequest"
},
"GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric": {
+ "description": "An observed value of a metric.",
+ "type": "object",
"properties": {
- "objectiveValue": {
- "description": "The objective value at this training step.",
- "format": "double",
- "type": "number"
- },
"trainingStep": {
"description": "The global training step for this metric.",
"format": "int64",
"type": "string"
+ },
+ "objectiveValue": {
+ "description": "The objective value at this training step.",
+ "format": "double",
+ "type": "number"
}
},
- "id": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric",
- "description": "An observed value of a metric.",
- "type": "object"
+ "id": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
},
"GoogleCloudMlV1__Version": {
"description": "Represents a version of the model.\n\nEach version is a trained model deployed in the cloud, ready to handle\nprediction requests. A model can have multiple versions. You can get\ninformation about all of the versions of a given model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).",
"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"
- },
"description": {
- "description": "Optional. The description specified for the version when it was created.",
- "type": "string"
+ "type": "string",
+ "description": "Optional. The description specified for the version when it was created."
},
"deploymentUri": {
"description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformaiton.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)\nthe model service uses the specified location as the source of the model.\nOnce deployed, the model version is hosted by the prediction service, so\nthis location is useful only as a historical record.\nThe total number of model files can't exceed 1000.",
@@ -790,11 +949,24 @@
},
"manualScaling": {
"$ref": "GoogleCloudMlV1__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."
+ "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `automatic_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want more\npredictable billing. Beware that latency and error rates will increase\nif the traffic exceeds that capability of the system to serve it based\non the selected number of nodes."
},
"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"
+ },
+ "automaticScaling": {
+ "$ref": "GoogleCloudMlV1__AutomaticScaling",
+ "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes."
+ },
+ "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"
@@ -822,12 +994,6 @@
"type": "number"
},
"scaleType": {
- "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",
@@ -835,7 +1001,13 @@
"UNIT_REVERSE_LOG_SCALE"
],
"description": "Optional. How the parameter should be scaled to the hypercube.\nLeave unset for categorical parameters.\nSome kind of scaling is strongly recommended for real or integral\nparameters (e.g., `UNIT_LINEAR_SCALE`).",
- "type": "string"
+ "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."
+ ]
},
"type": {
"enumDescriptions": [
@@ -856,8 +1028,8 @@
"type": "string"
},
"parameterName": {
- "type": "string",
- "description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\"."
+ "description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".",
+ "type": "string"
},
"categoricalValues": {
"description": "Required if type is `CATEGORICAL`. The list of possible categories.",
@@ -870,7 +1042,22 @@
"id": "GoogleCloudMlV1__ParameterSpec"
},
"GoogleCloudMlV1__PredictionInput": {
+ "id": "GoogleCloudMlV1__PredictionInput",
+ "description": "Represents input parameters for a prediction job.",
+ "type": "object",
"properties": {
+ "versionName": {
+ "type": "string",
+ "description": "Use this field if you want to specify a version of the model to use. The\nstring is formatted the same way as `model_version`, with the addition\nof the version information:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003eYOUR_MODEL/versions/\u003cvar\u003e[YOUR_VERSION]\u003c/var\u003e\"`"
+ },
+ "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": {
+ "type": "string",
+ "description": "Required. The output Google Cloud Storage location."
+ },
"uri": {
"description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
"type": "string"
@@ -881,12 +1068,6 @@
"type": "string"
},
"dataFormat": {
- "enum": [
- "DATA_FORMAT_UNSPECIFIED",
- "TEXT",
- "TF_RECORD",
- "TF_RECORD_GZIP"
- ],
"description": "Required. The format of the input data files.",
"type": "string",
"enumDescriptions": [
@@ -894,6 +1075,12 @@
"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"
]
},
"runtimeVersion": {
@@ -901,37 +1088,52 @@
"type": "string"
},
"inputPaths": {
- "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards."
},
"region": {
"description": "Required. The Google Compute Engine region to run the prediction job in.",
"type": "string"
- },
- "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"
}
- },
- "id": "GoogleCloudMlV1__PredictionInput",
- "description": "Represents input parameters for a prediction job.",
- "type": "object"
+ }
},
- "GoogleCloudMlV1__OperationMetadata": {
+ "GoogleCloudMlV1beta1__OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"type": "object",
"properties": {
+ "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"
+ },
"createTime": {
"description": "The time the operation was submitted.",
"format": "google-datetime",
@@ -942,49 +1144,19 @@
"type": "string"
},
"version": {
- "$ref": "GoogleCloudMlV1__Version",
+ "$ref": "GoogleCloudMlV1beta1__Version",
"description": "Contains the version associated with the operation."
- },
- "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": "GoogleCloudMlV1__OperationMetadata"
+ "id": "GoogleCloudMlV1beta1__OperationMetadata"
},
- "GoogleCloudMlV1beta1__OperationMetadata": {
+ "GoogleCloudMlV1__OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"type": "object",
"properties": {
"isCancellationRequested": {
- "description": "Indicates whether a request to cancel this operation has been made.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Indicates whether a request to cancel this operation has been made."
},
"createTime": {
"description": "The time the operation was submitted.",
@@ -992,25 +1164,19 @@
"type": "string"
},
"modelName": {
- "type": "string",
- "description": "Contains the name of the model associated with the operation."
- },
- "version": {
- "$ref": "GoogleCloudMlV1beta1__Version",
- "description": "Contains the version associated with the operation."
- },
- "endTime": {
- "description": "The time operation processing completed.",
- "format": "google-datetime",
+ "description": "Contains the name of the model associated with the operation.",
"type": "string"
},
+ "version": {
+ "description": "Contains the version associated with the operation.",
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "endTime": {
+ "type": "string",
+ "description": "The time operation processing completed.",
+ "format": "google-datetime"
+ },
"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",
@@ -1018,20 +1184,48 @@
"DELETE_MODEL"
],
"description": "The operation type.",
- "type": "string"
+ "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."
+ ]
},
"startTime": {
- "type": "string",
"description": "The time operation processing started.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "GoogleCloudMlV1beta1__OperationMetadata"
+ "id": "GoogleCloudMlV1__OperationMetadata"
},
"GoogleCloudMlV1__HyperparameterSpec": {
- "description": "Represents a set of hyperparameters to optimize.",
"type": "object",
"properties": {
+ "maxParallelTrials": {
+ "description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.",
+ "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"
+ },
"params": {
"description": "Required. The set of parameters to tune.",
"type": "array",
@@ -1043,102 +1237,74 @@
"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"
}
},
- "id": "GoogleCloudMlV1__HyperparameterSpec"
+ "id": "GoogleCloudMlV1__HyperparameterSpec",
+ "description": "Represents a set of hyperparameters to optimize."
},
"GoogleCloudMlV1__ListJobsResponse": {
- "id": "GoogleCloudMlV1__ListJobsResponse",
"description": "Response message for the ListJobs method.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
+ },
"jobs": {
"description": "The list of jobs.",
"type": "array",
"items": {
"$ref": "GoogleCloudMlV1__Job"
}
- },
- "nextPageToken": {
- "type": "string",
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call."
}
- }
+ },
+ "id": "GoogleCloudMlV1__ListJobsResponse"
},
"GoogleCloudMlV1__SetDefaultVersionRequest": {
- "id": "GoogleCloudMlV1__SetDefaultVersionRequest",
- "description": "Request message for the SetDefaultVersion request.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "GoogleCloudMlV1__SetDefaultVersionRequest",
+ "description": "Request message for the SetDefaultVersion request."
},
"GoogleLongrunning__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": "GoogleRpc__Status"
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"response": {
- "type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`."
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "type": "string",
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`."
+ },
+ "error": {
+ "$ref": "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": {
+ "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": {
- "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-engine/reference/rest/v1/projects.models.versions/setDefault)."
- },
"regions": {
"description": "Optional. The list of regions where the model is going to be deployed.\nCurrently only one region per model is supported.\nDefaults to 'us-central1' if nothing is set.\nNote:\n* No matter where a model is deployed, it can always be accessed by\n users from anywhere, both for online and batch prediction.\n* The region for a batch prediction job is set by the region field when\n submitting the batch prediction job and does not take its value from\n this field.",
"type": "array",
@@ -1153,25 +1319,34 @@
"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-engine/reference/rest/v1/projects.models.versions/setDefault)."
}
},
- "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"
+ "id": "GoogleCloudMlV1__Model"
},
"GoogleProtobuf__Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
- "id": "GoogleProtobuf__Empty"
+ "id": "GoogleProtobuf__Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
},
"GoogleCloudMlV1__CancelJobRequest": {
- "properties": {},
- "id": "GoogleCloudMlV1__CancelJobRequest",
"description": "Request message for the CancelJob method.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "GoogleCloudMlV1__CancelJobRequest"
},
"GoogleCloudMlV1__ListVersionsResponse": {
+ "id": "GoogleCloudMlV1__ListVersionsResponse",
+ "description": "Response message for the ListVersions method.",
+ "type": "object",
"properties": {
"versions": {
"description": "The list of versions.",
@@ -1181,20 +1356,17 @@
}
},
"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": "GoogleCloudMlV1__ListVersionsResponse",
- "description": "Response message for the ListVersions method.",
- "type": "object"
+ }
},
"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.",
+ "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to `nodes` * number of hours since\nlast billing cycle.",
"format": "int32",
"type": "integer"
}
@@ -1202,37 +1374,60 @@
"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.\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.",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There 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"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
}
},
"id": "GoogleRpc__Status"
},
- "GoogleCloudMlV1__TrainingInput": {
- "description": "Represents input parameters for a training job.",
+ "GoogleCloudMlV1__ListModelsResponse": {
+ "description": "Response message for the ListModels method.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
+ },
+ "models": {
+ "description": "The list of models.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Model"
+ }
+ }
+ },
+ "id": "GoogleCloudMlV1__ListModelsResponse"
+ },
+ "GoogleCloudMlV1__TrainingInput": {
+ "type": "object",
+ "properties": {
+ "parameterServerType": {
+ "type": "string",
+ "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."
+ },
"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.",
@@ -1246,9 +1441,7 @@
"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.",
@@ -1271,9 +1464,9 @@
}
},
"workerCount": {
+ "type": "string",
"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"
+ "format": "int64"
},
"masterType": {
"description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a\n \u003ca href=\"/ml-engine/docs/how-tos/using-gpus\"\u003e\n GPU that you can use in your trainer\u003c/a\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e that also includes\n four GPUs.\n \u003c/dd\u003e\n\u003c/dl\u003e\n\nYou must set this value when `scaleTier` is set to `CUSTOM`.",
@@ -1301,36 +1494,41 @@
"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"
}
},
- "id": "GoogleCloudMlV1__TrainingInput"
- },
- "GoogleCloudMlV1__ListModelsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
- },
- "models": {
- "description": "The list of models.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudMlV1__Model"
- }
- }
- },
- "id": "GoogleCloudMlV1__ListModelsResponse",
- "description": "Response message for the ListModels method."
+ "id": "GoogleCloudMlV1__TrainingInput",
+ "description": "Represents input parameters for a training job."
},
"GoogleCloudMlV1__Job": {
"description": "Represents a training or prediction job.",
"type": "object",
"properties": {
+ "jobId": {
+ "description": "Required. The user-specified id of the job.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "type": "string",
+ "description": "Output only. The details of a failure or a cancellation."
+ },
+ "endTime": {
+ "description": "Output only. When the job processing was completed.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "type": "string",
+ "description": "Output only. When the job processing was started.",
+ "format": "google-datetime"
+ },
+ "predictionOutput": {
+ "description": "The current prediction job result.",
+ "$ref": "GoogleCloudMlV1__PredictionOutput"
+ },
+ "trainingOutput": {
+ "$ref": "GoogleCloudMlV1__TrainingOutput",
+ "description": "The current training job result."
+ },
"trainingInput": {
"$ref": "GoogleCloudMlV1__TrainingInput",
"description": "Input parameters to create a training job."
@@ -1340,17 +1538,11 @@
"format": "google-datetime",
"type": "string"
},
+ "predictionInput": {
+ "description": "Input parameters to create a prediction job.",
+ "$ref": "GoogleCloudMlV1__PredictionInput"
+ },
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "QUEUED",
- "PREPARING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLING",
- "CANCELLED"
- ],
"description": "Output only. The detailed state of a job.",
"type": "string",
"enumDescriptions": [
@@ -1362,168 +1554,20 @@
"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": "GoogleCloudMlV1__PredictionInput"
- },
- "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": "GoogleCloudMlV1__PredictionOutput"
- },
- "trainingOutput": {
- "$ref": "GoogleCloudMlV1__TrainingOutput",
- "description": "The current training job result."
}
},
"id": "GoogleCloudMlV1__Job"
- },
- "GoogleApi__HttpBody": {
- "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"
- }
- },
- "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."
- },
- "GoogleCloudMlV1beta1__Version": {
- "type": "object",
- "properties": {
- "isDefault": {
- "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/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."
- },
- "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"
- },
- "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\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformaiton.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/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.\nThe total number of model files can't exceed 1000.",
- "type": "string"
- }
- },
- "id": "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-engine/reference/rest/v1beta1/projects.models.versions/list)."
- },
- "GoogleCloudMlV1__GetConfigResponse": {
- "description": "Returns service account information associated with a project.",
- "type": "object",
- "properties": {
- "serviceAccount": {
- "description": "The service account Cloud ML uses to access resources in the project.",
- "type": "string"
- },
- "serviceAccountProject": {
- "type": "string",
- "description": "The project number for `service_account`.",
- "format": "int64"
- }
- },
- "id": "GoogleCloudMlV1__GetConfigResponse"
- },
- "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": {
- "trialId": {
- "type": "string",
- "description": "The trial id for these results."
- },
- "allMetrics": {
- "description": "All recorded object metrics for this trial.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
- }
- },
- "finalMetric": {
- "description": "The final objective metric seen for this trial.",
- "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
- },
- "hyperparameters": {
- "description": "The hyperparameters given to this trial.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- }
- },
- "GoogleCloudMlV1__PredictionOutput": {
- "description": "Represents results of a prediction job.",
- "type": "object",
- "properties": {
- "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"
- },
- "errorCount": {
- "description": "The number of data instances which resulted in errors.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GoogleCloudMlV1__PredictionOutput"
}
},
"icons": {
@@ -1545,6 +1589,5 @@
"ownerDomain": "google.com",
"name": "ml",
"batchPath": "batch",
- "title": "Google Cloud Machine Learning Engine",
- "ownerName": "Google"
+ "title": "Google Cloud Machine Learning Engine"
}
diff --git a/ml/v1/ml-gen.go b/ml/v1/ml-gen.go
index 30d3e02..f2d38fb 100644
--- a/ml/v1/ml-gen.go
+++ b/ml/v1/ml-gen.go
@@ -186,6 +186,11 @@
// Data: HTTP body binary data.
Data string `json:"data,omitempty"`
+ // Extensions: Application specific response metadata. Must be set in
+ // the first response
+ // for streaming APIs.
+ Extensions []googleapi.RawMessage `json:"extensions,omitempty"`
+
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
@@ -260,6 +265,63 @@
return nil
}
+// GoogleCloudMlV1__AutomaticScaling: Options for automatically scaling
+// a model.
+type GoogleCloudMlV1__AutomaticScaling struct {
+ // MinNodes: Optional. The minimum 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 at least
+ // `rate` * `min_nodes` * number of hours since last billing
+ // cycle,
+ // where `rate` is the cost per node-hour as documented
+ // in
+ // [pricing](https://cloud.google.com/ml-engine/pricing#prediction_pri
+ // cing),
+ // even if no predictions are performed. There is additional cost for
+ // each
+ // prediction performed.
+ //
+ // Unlike manual scaling, if the load gets too heavy for the nodes
+ // that are up, the service will automatically add nodes to handle
+ // the
+ // increased load as well as scale back as traffic drops, always
+ // maintaining
+ // at least `min_nodes`. You will be charged for the time in which
+ // additional
+ // nodes are used.
+ //
+ // If not specified, `min_nodes` defaults to 0, in which case, when
+ // traffic
+ // to a model stops (and after a cool-down period), nodes will be shut
+ // down
+ // and no charges will be incurred until traffic to the model resumes.
+ MinNodes int64 `json:"minNodes,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "MinNodes") 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. "MinNodes") 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__AutomaticScaling) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__AutomaticScaling
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// GoogleCloudMlV1__CancelJobRequest: Request message for the CancelJob
// method.
type GoogleCloudMlV1__CancelJobRequest struct {
@@ -615,9 +677,9 @@
// 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
+ // this model will be proportional to `nodes` * number of hours
// since
- // deployment.
+ // last billing cycle plus the cost for each prediction performed.
Nodes int64 `json:"nodes,omitempty"`
// ForceSendFields is a list of field names (e.g. "Nodes") to
@@ -1561,6 +1623,13 @@
// [projects.models.versions.list](/ml-engine/reference/rest/v1/p
// rojects.models.versions/list).
type GoogleCloudMlV1__Version struct {
+ // AutomaticScaling: Automatically scale the number of nodes used to
+ // serve the model in
+ // response to increases and decreases in traffic. Care should be
+ // taken to ramp up traffic according to the model's ability to scale
+ // or you will start seeing increases in latency and 429 response codes.
+ AutomaticScaling *GoogleCloudMlV1__AutomaticScaling `json:"automaticScaling,omitempty"`
+
// CreateTime: Output only. The time the version was created.
CreateTime string `json:"createTime,omitempty"`
@@ -1603,17 +1672,17 @@
// 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: Manually select the number of nodes to use for serving
+ // the
+ // model. You should generally use `automatic_scaling` with an
+ // appropriate
+ // `min_nodes` instead, but this option is available if you want
+ // more
+ // predictable billing. Beware that latency and error rates will
+ // increase
+ // if the traffic exceeds that capability of the system to serve it
+ // based
+ // on the selected number of nodes.
ManualScaling *GoogleCloudMlV1__ManualScaling `json:"manualScaling,omitempty"`
// Name: Required.The name specified for the version when it was
@@ -1631,7 +1700,7 @@
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "CreateTime") to
+ // ForceSendFields is a list of field names (e.g. "AutomaticScaling") 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
@@ -1639,7 +1708,65 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "CreateTime") to include in
+ // NullFields is a list of field names (e.g. "AutomaticScaling") 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__AutomaticScaling: Options for automatically
+// scaling a model.
+type GoogleCloudMlV1beta1__AutomaticScaling struct {
+ // MinNodes: Optional. The minimum 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 at least
+ // `rate` * `min_nodes` * number of hours since last billing
+ // cycle,
+ // where `rate` is the cost per node-hour as documented
+ // in
+ // [pricing](https://cloud.google.com/ml-engine/pricing#prediction_pri
+ // cing),
+ // even if no predictions are performed. There is additional cost for
+ // each
+ // prediction performed.
+ //
+ // Unlike manual scaling, if the load gets too heavy for the nodes
+ // that are up, the service will automatically add nodes to handle
+ // the
+ // increased load as well as scale back as traffic drops, always
+ // maintaining
+ // at least `min_nodes`. You will be charged for the time in which
+ // additional
+ // nodes are used.
+ //
+ // If not specified, `min_nodes` defaults to 0, in which case, when
+ // traffic
+ // to a model stops (and after a cool-down period), nodes will be shut
+ // down
+ // and no charges will be incurred until traffic to the model resumes.
+ MinNodes int64 `json:"minNodes,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "MinNodes") 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. "MinNodes") 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
@@ -1648,8 +1775,8 @@
NullFields []string `json:"-"`
}
-func (s *GoogleCloudMlV1__Version) MarshalJSON() ([]byte, error) {
- type noMethod GoogleCloudMlV1__Version
+func (s *GoogleCloudMlV1beta1__AutomaticScaling) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1beta1__AutomaticScaling
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
@@ -1661,9 +1788,9 @@
// 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
+ // this model will be proportional to `nodes` * number of hours
// since
- // deployment.
+ // last billing cycle.
Nodes int64 `json:"nodes,omitempty"`
// ForceSendFields is a list of field names (e.g. "Nodes") to
@@ -1756,6 +1883,13 @@
// [projects.models.versions.list](/ml-engine/reference/rest/v1be
// ta1/projects.models.versions/list).
type GoogleCloudMlV1beta1__Version struct {
+ // AutomaticScaling: Automatically scale the number of nodes used to
+ // serve the model in
+ // response to increases and decreases in traffic. Care should be
+ // taken to ramp up traffic according to the model's ability to scale
+ // or you will start seeing increases in latency and 429 response codes.
+ AutomaticScaling *GoogleCloudMlV1beta1__AutomaticScaling `json:"automaticScaling,omitempty"`
+
// CreateTime: Output only. The time the version was created.
CreateTime string `json:"createTime,omitempty"`
@@ -1798,17 +1932,17 @@
// 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: Manually select the number of nodes to use for serving
+ // the
+ // model. You should generally use `automatic_scaling` with an
+ // appropriate
+ // `min_nodes` instead, but this option is available if you want
+ // predictable
+ // billing. Beware that latency and error rates will increase if
+ // the
+ // traffic exceeds that capability of the system to serve it based
+ // on
+ // the selected number of nodes.
ManualScaling *GoogleCloudMlV1beta1__ManualScaling `json:"manualScaling,omitempty"`
// Name: Required.The name specified for the version when it was
@@ -1822,7 +1956,7 @@
// 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
+ // ForceSendFields is a list of field names (e.g. "AutomaticScaling") 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
@@ -1830,12 +1964,13 @@
// 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 is a list of field names (e.g. "AutomaticScaling") 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:"-"`
}
@@ -2003,7 +2138,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -4818,9 +4953,18 @@
// server doesn't support this method, it returns
// `UNIMPLEMENTED`.
//
-// NOTE: the `name` binding below allows API services to override the
+// NOTE: the `name` binding allows API services to override the
// binding
// to use different resource name schemes, such as `users/*/operations`.
+// To
+// override the binding, API services can add a binding such
+// as
+// "/v1/{name=users/*}/operations" to their service configuration.
+// For backwards compatibility, the default name includes the
+// operations
+// collection id, however overriding users must ensure the name
+// binding
+// is the parent resource, without the operations collection id.
func (r *ProjectsOperationsService) List(name string) *ProjectsOperationsListCall {
c := &ProjectsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -4944,7 +5088,7 @@
}
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`.",
+ // "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
// "flatPath": "v1/projects/{projectsId}/operations",
// "httpMethod": "GET",
// "id": "ml.projects.operations.list",
@@ -4958,7 +5102,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "path",
// "pattern": "^projects/[^/]+$",
// "required": true,
diff --git a/ml/v1beta1/ml-api.json b/ml/v1beta1/ml-api.json
index 813a7f1..823327f 100644
--- a/ml/v1beta1/ml-api.json
+++ b/ml/v1beta1/ml-api.json
@@ -1,8 +1,923 @@
{
+ "resources": {
+ "projects": {
+ "resources": {
+ "jobs": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__ListJobsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "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": {
+ "description": "Optional. The number of jobs to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "Required. The name of the project for which to list jobs.\n\nAuthorization: requires `Viewer` role on the specified project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. Specifies the subset of jobs to retrieve."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/jobs",
+ "id": "ml.projects.jobs.list",
+ "path": "v1beta1/{+parent}/jobs",
+ "description": "Lists the jobs in the project."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__Job"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/jobs/{jobsId}",
+ "id": "ml.projects.jobs.get",
+ "path": "v1beta1/{+name}",
+ "description": "Describes a job."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__Job"
+ },
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project."
+ }
+ },
+ "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."
+ },
+ "cancel": {
+ "request": {
+ "$ref": "GoogleCloudMlV1beta1__CancelJobRequest"
+ },
+ "description": "Cancels a running job.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/jobs/{jobsId}:cancel",
+ "id": "ml.projects.jobs.cancel",
+ "path": "v1beta1/{+name}:cancel"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}:cancel",
+ "id": "ml.projects.operations.cancel",
+ "path": "v1beta1/{+name}:cancel"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}",
+ "id": "ml.projects.operations.delete",
+ "path": "v1beta1/{+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": {
+ "response": {
+ "$ref": "GoogleLongrunning__ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/operations",
+ "path": "v1beta1/{+name}/operations",
+ "id": "ml.projects.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}",
+ "id": "ml.projects.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."
+ }
+ }
+ },
+ "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": "v1beta1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1beta1/{+name}",
+ "id": "ml.projects.models.delete",
+ "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1beta1/projects.models.versions/delete)."
+ },
+ "list": {
+ "path": "v1beta1/{+parent}/models",
+ "id": "ml.projects.models.list",
+ "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions.",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__ListModelsResponse"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "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"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/models"
+ },
+ "get": {
+ "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).",
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__Model"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__Model"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/models",
+ "id": "ml.projects.models.create",
+ "path": "v1beta1/{+parent}/models",
+ "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1beta1/projects.models.versions/create).",
+ "request": {
+ "$ref": "GoogleCloudMlV1beta1__Model"
+ }
+ }
+ },
+ "resources": {
+ "versions": {
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "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": "v1beta1/projects/{projectsId}/models/{modelsId}/versions",
+ "id": "ml.projects.models.versions.create",
+ "path": "v1beta1/{+parent}/versions",
+ "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).",
+ "request": {
+ "$ref": "GoogleCloudMlV1beta1__Version"
+ }
+ },
+ "setDefault": {
+ "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
+ "id": "ml.projects.models.versions.setDefault",
+ "path": "v1beta1/{+name}: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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__Version"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project."
+ }
+ }
+ },
+ "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.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "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-engine/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}",
+ "id": "ml.projects.models.versions.delete",
+ "path": "v1beta1/{+name}"
+ },
+ "list": {
+ "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": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "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"
+ },
+ "pageToken": {
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "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):",
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
+ },
+ "get": {
+ "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model.",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "methods": {
+ "getConfig": {
+ "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.",
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__GetConfigResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project name.\n\nAuthorization: requires `Viewer` role on the specified project."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}:getConfig",
+ "path": "v1beta1/{+name}:getConfig",
+ "id": "ml.projects.getConfig"
+ },
+ "predict": {
+ "parameters": {
+ "name": {
+ "pattern": "^projects/.+$",
+ "location": "path",
+ "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}:predict",
+ "id": "ml.projects.predict",
+ "path": "v1beta1/{+name}:predict",
+ "request": {
+ "$ref": "GoogleCloudMlV1beta1__PredictRequest"
+ },
+ "description": "Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleApi__HttpBody"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "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."
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "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"
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://ml.googleapis.com/",
+ "servicePath": "",
+ "description": "An API to enable creating and using machine learning models.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "ml:v1beta1",
+ "documentationLink": "https://cloud.google.com/ml/",
+ "revision": "20170527",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "GoogleCloudMlV1beta1__HyperparameterSpec": {
+ "id": "GoogleCloudMlV1beta1__HyperparameterSpec",
+ "description": "Represents a set of hyperparameters to optimize.",
+ "type": "object",
+ "properties": {
+ "goal": {
+ "type": "string",
+ "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`."
+ },
+ "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",
+ "items": {
+ "$ref": "GoogleCloudMlV1beta1__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"
+ }
+ }
+ },
+ "GoogleCloudMlV1beta1__OperationMetadata": {
+ "description": "Represents the metadata of the long-running operation.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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": {
+ "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"
+ ],
+ "description": "The operation type."
+ },
+ "startTime": {
+ "description": "The time operation processing started.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__OperationMetadata"
+ },
+ "GoogleCloudMlV1__OperationMetadata": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "version": {
+ "description": "Contains the version associated with the operation.",
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "endTime": {
+ "description": "The time operation processing completed.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "operationType": {
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE_VERSION",
+ "DELETE_VERSION",
+ "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."
+ ]
+ },
+ "startTime": {
+ "description": "The time operation processing started.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1__OperationMetadata",
+ "description": "Represents the metadata of the long-running operation."
+ },
+ "GoogleCloudMlV1beta1__ListModelsResponse": {
+ "description": "Response message for the ListModels method.",
+ "type": "object",
+ "properties": {
+ "models": {
+ "description": "The list of models.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1beta1__Model"
+ }
+ },
+ "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": {
+ "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": "GoogleRpc__Status"
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "GoogleLongrunning__Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
+ },
+ "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": {
+ "allMetrics": {
+ "description": "All recorded object metrics for this trial.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric"
+ }
+ },
+ "finalMetric": {
+ "description": "The final objective metric seen for this trial.",
+ "$ref": "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric"
+ },
+ "hyperparameters": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The hyperparameters given to this trial."
+ },
+ "trialId": {
+ "description": "The trial id for these results.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__HyperparameterOutput"
+ },
+ "GoogleProtobuf__Empty": {
+ "properties": {},
+ "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"
+ },
+ "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\nlast billing cycle.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__ManualScaling"
+ },
"GoogleRpc__Status": {
+ "id": "GoogleRpc__Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
@@ -17,53 +932,28 @@
"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."
+ }
}
}
- },
- "id": "GoogleRpc__Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` 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.\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"
+ }
},
"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"
},
- "GoogleApi__HttpBody": {
- "properties": {
- "data": {
- "type": "string",
- "description": "HTTP body binary data.",
- "format": "byte"
- },
- "contentType": {
- "description": "The HTTP Content-Type string representing the content type of the body.",
- "type": "string"
- }
- },
- "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"
- },
"GoogleCloudMlV1beta1__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"
@@ -76,16 +966,17 @@
"description": "Required. The output Google Cloud Storage location.",
"type": "string"
},
- "uri": {
- "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
- "type": "string"
- },
"maxWorkerCount": {
"description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified.",
"format": "int64",
"type": "string"
},
+ "uri": {
+ "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
+ "type": "string"
+ },
"dataFormat": {
+ "type": "string",
"enumDescriptions": [
"Unspecified format.",
"The source file is a text file with instances separated by the\nnew-line character.",
@@ -98,8 +989,7 @@
"TF_RECORD",
"TF_RECORD_GZIP"
],
- "description": "Required. The format of the input data files.",
- "type": "string"
+ "description": "Required. The format of the input data files."
},
"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.",
@@ -111,68 +1001,42 @@
"items": {
"type": "string"
}
- }
- },
- "id": "GoogleCloudMlV1beta1__PredictionInput"
- },
- "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-engine/reference/rest/v1beta1/projects.models.versions/list).",
- "type": "object",
- "properties": {
- "deploymentUri": {
- "description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformaiton.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/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.\nThe total number of model files can't exceed 1000.",
- "type": "string"
},
- "isDefault": {
- "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/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": "GoogleCloudMlV1beta1__ManualScaling"
- },
- "name": {
- "type": "string",
- "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."
- },
- "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"
- },
- "description": {
- "description": "Optional. The description specified for the version when it was created.",
+ "region": {
+ "description": "Required. The Google Compute Engine region to run the prediction job in.",
"type": "string"
}
},
- "id": "GoogleCloudMlV1beta1__Version"
+ "id": "GoogleCloudMlV1beta1__PredictionInput",
+ "description": "Represents input parameters for a prediction job.",
+ "type": "object"
},
- "GoogleCloudMlV1beta1__ListJobsResponse": {
+ "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": {
- "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.",
+ "extensions": {
+ "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.",
"type": "array",
"items": {
- "$ref": "GoogleCloudMlV1beta1__Job"
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
}
+ },
+ "data": {
+ "description": "HTTP body binary data.",
+ "format": "byte",
+ "type": "string"
+ },
+ "contentType": {
+ "type": "string",
+ "description": "The HTTP Content-Type string representing the content type of the body."
}
},
- "id": "GoogleCloudMlV1beta1__ListJobsResponse",
- "description": "Response message for the ListJobs method."
+ "id": "GoogleApi__HttpBody"
},
"GoogleCloudMlV1beta1__ListVersionsResponse": {
"description": "Response message for the ListVersions method.",
@@ -192,8 +1056,99 @@
},
"id": "GoogleCloudMlV1beta1__ListVersionsResponse"
},
- "GoogleCloudMlV1beta1__Model": {
+ "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-engine/reference/rest/v1beta1/projects.models.versions/list).",
+ "type": "object",
"properties": {
+ "manualScaling": {
+ "$ref": "GoogleCloudMlV1beta1__ManualScaling",
+ "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `automatic_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want predictable\nbilling. Beware that latency and error rates will increase if the\ntraffic exceeds that capability of the system to serve it based on\nthe selected number of nodes."
+ },
+ "name": {
+ "type": "string",
+ "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."
+ },
+ "automaticScaling": {
+ "$ref": "GoogleCloudMlV1beta1__AutomaticScaling",
+ "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes."
+ },
+ "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"
+ },
+ "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\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformaiton.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/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.\nThe total number of model files can't exceed 1000.",
+ "type": "string"
+ },
+ "isDefault": {
+ "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).",
+ "type": "boolean"
+ },
+ "createTime": {
+ "type": "string",
+ "description": "Output only. The time the version was created.",
+ "format": "google-datetime"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__Version"
+ },
+ "GoogleCloudMlV1beta1__ListJobsResponse": {
+ "description": "Response message for the ListJobs method.",
+ "type": "object",
+ "properties": {
+ "jobs": {
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1beta1__Job"
+ },
+ "description": "The list of jobs."
+ },
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__ListJobsResponse"
+ },
+ "GoogleCloudMlV1beta1__CancelJobRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "GoogleCloudMlV1beta1__CancelJobRequest",
+ "description": "Request message for the CancelJob method."
+ },
+ "GoogleCloudMlV1__AutomaticScaling": {
+ "description": "Options for automatically scaling a model.",
+ "type": "object",
+ "properties": {
+ "minNodes": {
+ "description": "Optional. The minimum number of nodes to allocate for this model. These\nnodes are always up, starting from the time the model is deployed, so the\ncost of operating this model will be at least\n`rate` * `min_nodes` * number of hours since last billing cycle,\nwhere `rate` is the cost per node-hour as documented in\n[pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),\neven if no predictions are performed. There is additional cost for each\nprediction performed.\n\nUnlike manual scaling, if the load gets too heavy for the nodes\nthat are up, the service will automatically add nodes to handle the\nincreased load as well as scale back as traffic drops, always maintaining\nat least `min_nodes`. You will be charged for the time in which additional\nnodes are used.\n\nIf not specified, `min_nodes` defaults to 0, in which case, when traffic\nto a model stops (and after a cool-down period), nodes will be shut down\nand no charges will be incurred until traffic to the model resumes.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1__AutomaticScaling"
+ },
+ "GoogleCloudMlV1beta1__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": {
+ "onlinePredictionLogging": {
+ "description": "Optional. If true, enables StackDriver Logging for online prediction.\nDefault is false.",
+ "type": "boolean"
+ },
+ "defaultVersion": {
+ "description": "Output only. The default version of the model. This version will be used to\nhandle prediction requests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).",
+ "$ref": "GoogleCloudMlV1beta1__Version"
+ },
"regions": {
"description": "Optional. The list of regions where the model is going to be deployed.\nCurrently only one region per model is supported.\nDefaults to 'us-central1' if nothing is set.\nNote:\n* No matter where a model is deployed, it can always be accessed by\n users from anywhere, both for online and batch prediction.\n* The region for a batch prediction job is set by the region field when\n submitting the batch prediction job and does not take its value from\n this field.",
"type": "array",
@@ -202,72 +1157,20 @@
}
},
"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.",
"type": "string"
- },
- "onlinePredictionLogging": {
- "description": "Optional. If true, enables StackDriver Logging for online prediction.\nDefault is false.",
- "type": "boolean"
- },
- "defaultVersion": {
- "description": "Output only. The default version of the model. This version will be used to\nhandle prediction requests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).",
- "$ref": "GoogleCloudMlV1beta1__Version"
}
},
- "id": "GoogleCloudMlV1beta1__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"
- },
- "GoogleCloudMlV1beta1__CancelJobRequest": {
- "description": "Request message for the CancelJob method.",
- "type": "object",
- "properties": {},
- "id": "GoogleCloudMlV1beta1__CancelJobRequest"
+ "id": "GoogleCloudMlV1beta1__Model"
},
"GoogleCloudMlV1beta1__Job": {
"description": "Represents a training or prediction job.",
"type": "object",
"properties": {
- "predictionInput": {
- "description": "Input parameters to create a prediction job.",
- "$ref": "GoogleCloudMlV1beta1__PredictionInput"
- },
- "state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "QUEUED",
- "PREPARING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLING",
- "CANCELLED"
- ],
- "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."
- ]
- },
- "errorMessage": {
- "description": "Output only. The details of a failure or a cancellation.",
- "type": "string"
- },
- "jobId": {
- "type": "string",
- "description": "Required. The user-specified id of the job."
- },
"endTime": {
"description": "Output only. When the job processing was completed.",
"format": "google-datetime",
@@ -279,8 +1182,8 @@
"type": "string"
},
"predictionOutput": {
- "description": "The current prediction job result.",
- "$ref": "GoogleCloudMlV1beta1__PredictionOutput"
+ "$ref": "GoogleCloudMlV1beta1__PredictionOutput",
+ "description": "The current prediction job result."
},
"trainingOutput": {
"$ref": "GoogleCloudMlV1beta1__TrainingOutput",
@@ -292,42 +1195,66 @@
"type": "string"
},
"trainingInput": {
- "$ref": "GoogleCloudMlV1beta1__TrainingInput",
- "description": "Input parameters to create a training job."
+ "description": "Input parameters to create a training job.",
+ "$ref": "GoogleCloudMlV1beta1__TrainingInput"
+ },
+ "predictionInput": {
+ "$ref": "GoogleCloudMlV1beta1__PredictionInput",
+ "description": "Input parameters to create a prediction job."
+ },
+ "state": {
+ "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"
+ ],
+ "description": "Output only. The detailed state of a job.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "type": "string",
+ "description": "Output only. The details of a failure or a cancellation."
+ },
+ "jobId": {
+ "description": "Required. The user-specified id of the job.",
+ "type": "string"
}
},
"id": "GoogleCloudMlV1beta1__Job"
},
- "GoogleCloudMlV1beta1__TrainingInput": {
+ "GoogleCloudMlV1beta1__AutomaticScaling": {
+ "description": "Options for automatically scaling a model.",
"type": "object",
"properties": {
- "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"
- },
+ "minNodes": {
+ "description": "Optional. The minimum number of nodes to allocate for this model. These\nnodes are always up, starting from the time the model is deployed, so the\ncost of operating this model will be at least\n`rate` * `min_nodes` * number of hours since last billing cycle,\nwhere `rate` is the cost per node-hour as documented in\n[pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),\neven if no predictions are performed. There is additional cost for each\nprediction performed.\n\nUnlike manual scaling, if the load gets too heavy for the nodes\nthat are up, the service will automatically add nodes to handle the\nincreased load as well as scale back as traffic drops, always maintaining\nat least `min_nodes`. You will be charged for the time in which additional\nnodes are used.\n\nIf not specified, `min_nodes` defaults to 0, in which case, when traffic\nto a model stops (and after a cool-down period), nodes will be shut down\nand no charges will be incurred until traffic to the model resumes.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__AutomaticScaling"
+ },
+ "GoogleCloudMlV1beta1__TrainingInput": {
+ "id": "GoogleCloudMlV1beta1__TrainingInput",
+ "description": "Represents input parameters for a training job.",
+ "type": "object",
+ "properties": {
"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-engine/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",
@@ -336,11 +1263,18 @@
"CUSTOM"
],
"description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.",
- "type": "string"
+ "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-engine/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."
+ ]
},
"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"
+ "type": "string",
+ "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."
},
"hyperparameters": {
"description": "Optional. The set of Hyperparameters to tune.",
@@ -374,33 +1308,48 @@
"pythonModule": {
"description": "Required. The Python module name to run after installing the packages.",
"type": "string"
- }
- },
- "id": "GoogleCloudMlV1beta1__TrainingInput",
- "description": "Represents input parameters for a training job."
- },
- "GoogleLongrunning__ListOperationsResponse": {
- "id": "GoogleLongrunning__ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "operations": {
+ },
+ "args": {
+ "description": "Optional. Command line arguments to pass to the program.",
"type": "array",
"items": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "description": "A list of operations that matches the specified filter in the request."
+ "type": "string"
+ }
},
- "nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
+ "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"
}
}
},
- "GoogleCloudMlV1beta1__GetConfigResponse": {
- "description": "Returns service account information associated with a project.",
+ "GoogleLongrunning__ListOperationsResponse": {
"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",
+ "description": "The response message for Operations.ListOperations."
+ },
+ "GoogleCloudMlV1beta1__GetConfigResponse": {
+ "properties": {
"serviceAccount": {
"description": "The service account Cloud ML uses to access resources in the project.",
"type": "string"
@@ -411,35 +1360,32 @@
"type": "string"
}
},
- "id": "GoogleCloudMlV1beta1__GetConfigResponse"
+ "id": "GoogleCloudMlV1beta1__GetConfigResponse",
+ "description": "Returns service account information associated with a project.",
+ "type": "object"
},
"GoogleCloudMlV1beta1__SetDefaultVersionRequest": {
+ "id": "GoogleCloudMlV1beta1__SetDefaultVersionRequest",
"description": "Request message for the SetDefaultVersion request.",
"type": "object",
- "properties": {},
- "id": "GoogleCloudMlV1beta1__SetDefaultVersionRequest"
+ "properties": {}
},
"GoogleCloudMlV1__ManualScaling": {
+ "id": "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.",
+ "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to `nodes` * number of hours since\nlast billing cycle plus the cost for each prediction performed.",
"format": "int32",
"type": "integer"
}
- },
- "id": "GoogleCloudMlV1__ManualScaling"
+ }
},
"GoogleCloudMlV1beta1__ParameterSpec": {
"description": "Represents a single hyperparameter to optimize.",
"type": "object",
"properties": {
- "minValue": {
- "description": "Required if type is `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is INTEGER.",
- "format": "double",
- "type": "number"
- },
"discreteValues": {
"description": "Required if type is `DISCRETE`.\nA list of feasible points.\nThe list should be in strictly increasing order. For instance, this\nparameter might have possible settings of 1.5, 2.5, and 4.0. This list\nshould not contain more than 1,000 values.",
"type": "array",
@@ -465,18 +1411,11 @@
"type": "string"
},
"maxValue": {
+ "type": "number",
"description": "Required if typeis `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is `INTEGER`.",
- "format": "double",
- "type": "number"
+ "format": "double"
},
"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",
@@ -485,7 +1424,14 @@
"DISCRETE"
],
"description": "Required. The type of the parameter.",
- "type": "string"
+ "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."
+ ]
},
"categoricalValues": {
"description": "Required if type is `CATEGORICAL`. The list of possible categories.",
@@ -497,6 +1443,11 @@
"parameterName": {
"description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".",
"type": "string"
+ },
+ "minValue": {
+ "description": "Required if type is `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is INTEGER.",
+ "format": "double",
+ "type": "number"
}
},
"id": "GoogleCloudMlV1beta1__ParameterSpec"
@@ -519,30 +1470,30 @@
"id": "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric"
},
"GoogleCloudMlV1beta1__PredictionOutput": {
+ "id": "GoogleCloudMlV1beta1__PredictionOutput",
"description": "Represents results of a prediction job.",
"type": "object",
"properties": {
"errorCount": {
- "type": "string",
"description": "The number of data instances which resulted in errors.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"outputPath": {
"description": "The output Google Cloud Storage location provided at the job creation time.",
"type": "string"
},
"nodeHours": {
+ "type": "number",
"description": "Node hours used by the batch prediction job.",
- "format": "double",
- "type": "number"
+ "format": "double"
},
"predictionCount": {
"description": "The number of generated predictions.",
"format": "int64",
"type": "string"
}
- },
- "id": "GoogleCloudMlV1beta1__PredictionOutput"
+ }
},
"GoogleCloudMlV1beta1__TrainingOutput": {
"description": "Represents results of a training job. Output only.",
@@ -576,289 +1527,51 @@
"description": "Represents a version of the model.\n\nEach version is a trained model deployed in the cloud, ready to handle\nprediction requests. A model can have multiple versions. You can get\ninformation about all of the versions of a given model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).",
"type": "object",
"properties": {
- "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": {
- "type": "string",
- "description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformaiton.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)\nthe model service uses the specified location as the source of the model.\nOnce deployed, the model version is hosted by the prediction service, so\nthis location is useful only as a historical record.\nThe total number of model files can't exceed 1000."
- },
- "isDefault": {
- "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
- "type": "boolean"
- },
"createTime": {
"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"
+ "$ref": "GoogleCloudMlV1__ManualScaling",
+ "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `automatic_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want more\npredictable billing. Beware that latency and error rates will increase\nif the traffic exceeds that capability of the system to serve it based\non the selected number of nodes."
},
"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"
+ },
+ "automaticScaling": {
+ "$ref": "GoogleCloudMlV1__AutomaticScaling",
+ "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes."
+ },
+ "lastUseTime": {
+ "description": "Output only. The time the version was last used for prediction.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "runtimeVersion": {
+ "type": "string",
+ "description": "Optional. The Google Cloud ML runtime version to use for this deployment.\nIf not set, Google Cloud ML will choose a version."
+ },
+ "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\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformaiton.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)\nthe model service uses the specified location as the source of the model.\nOnce deployed, the model version is hosted by the prediction service, so\nthis location is useful only as a historical record.\nThe total number of model files can't exceed 1000.",
+ "type": "string"
+ },
+ "isDefault": {
+ "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
+ "type": "boolean"
}
},
"id": "GoogleCloudMlV1__Version"
- },
- "GoogleCloudMlV1beta1__HyperparameterSpec": {
- "description": "Represents a set of hyperparameters to optimize.",
- "type": "object",
- "properties": {
- "maxParallelTrials": {
- "description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.",
- "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"
- },
- "params": {
- "type": "array",
- "items": {
- "$ref": "GoogleCloudMlV1beta1__ParameterSpec"
- },
- "description": "Required. The set of parameters to tune."
- },
- "maxTrials": {
- "description": "Optional. How many training trials should be attempted to optimize\nthe specified hyperparameters.\n\nDefaults to one.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GoogleCloudMlV1beta1__HyperparameterSpec"
- },
- "GoogleCloudMlV1beta1__OperationMetadata": {
- "description": "Represents the metadata of the long-running operation.",
- "type": "object",
- "properties": {
- "operationType": {
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE_VERSION",
- "DELETE_VERSION",
- "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."
- ]
- },
- "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"
- },
- "version": {
- "description": "Contains the version associated with the operation.",
- "$ref": "GoogleCloudMlV1beta1__Version"
- },
- "endTime": {
- "description": "The time operation processing completed.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "GoogleCloudMlV1beta1__OperationMetadata"
- },
- "GoogleCloudMlV1__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": {
- "$ref": "GoogleCloudMlV1__Version",
- "description": "Contains the version associated with the operation."
- },
- "endTime": {
- "type": "string",
- "description": "The time operation processing completed.",
- "format": "google-datetime"
- },
- "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": "GoogleCloudMlV1__OperationMetadata"
- },
- "GoogleCloudMlV1beta1__ListModelsResponse": {
- "description": "Response message for the ListModels method.",
- "type": "object",
- "properties": {
- "models": {
- "description": "The list of models.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudMlV1beta1__Model"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call."
- }
- },
- "id": "GoogleCloudMlV1beta1__ListModelsResponse"
- },
- "GoogleLongrunning__Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "GoogleRpc__Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- }
- },
- "id": "GoogleLongrunning__Operation"
- },
- "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": {
- "finalMetric": {
- "$ref": "GoogleCloudMlV1beta1_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"
- },
- "allMetrics": {
- "description": "All recorded object metrics for this trial.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric"
- }
- }
- }
- },
- "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"
- },
- "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"
}
},
"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 Machine Learning Engine",
@@ -876,675 +1589,5 @@
"name": "ml",
"batchPath": "batch",
"title": "Google Cloud Machine Learning Engine",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "predict": {
- "response": {
- "$ref": "GoogleApi__HttpBody"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/.+$",
- "location": "path",
- "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires `Viewer` role on the parent project.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}:predict",
- "path": "v1beta1/{+name}:predict",
- "id": "ml.projects.predict",
- "description": "Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION",
- "request": {
- "$ref": "GoogleCloudMlV1beta1__PredictRequest"
- }
- },
- "getConfig": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1beta1__GetConfigResponse"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The project name.\n\nAuthorization: requires `Viewer` role on the specified project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}:getConfig",
- "id": "ml.projects.getConfig",
- "path": "v1beta1/{+name}:getConfig",
- "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning."
- }
- },
- "resources": {
- "operations": {
- "methods": {
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding 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",
- "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": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the operation collection."
- },
- "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": "v1beta1/projects/{projectsId}/operations",
- "path": "v1beta1/{+name}/operations",
- "id": "ml.projects.operations.list"
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}",
- "path": "v1beta1/{+name}",
- "id": "ml.projects.operations.get"
- },
- "cancel": {
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}:cancel",
- "path": "v1beta1/{+name}:cancel",
- "id": "ml.projects.operations.cancel"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "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": "v1beta1/projects/{projectsId}/operations/{operationsId}",
- "id": "ml.projects.operations.delete",
- "path": "v1beta1/{+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`."
- }
- }
- },
- "models": {
- "methods": {
- "delete": {
- "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1beta1/projects.models.versions/delete).",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The name of the model.\n\nAuthorization: requires `Editor` role on the parent project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}",
- "id": "ml.projects.models.delete",
- "path": "v1beta1/{+name}"
- },
- "list": {
- "response": {
- "$ref": "GoogleCloudMlV1beta1__ListModelsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The name of the project whose models are to be listed.\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": "v1beta1/projects/{projectsId}/models",
- "path": "v1beta1/{+parent}/models",
- "id": "ml.projects.models.list",
- "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions."
- },
- "get": {
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The name of the model.\n\nAuthorization: requires `Viewer` role on the parent project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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).",
- "response": {
- "$ref": "GoogleCloudMlV1beta1__Model"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET"
- },
- "create": {
- "response": {
- "$ref": "GoogleCloudMlV1beta1__Model"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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}/models",
- "path": "v1beta1/{+parent}/models",
- "id": "ml.projects.models.create",
- "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1beta1/projects.models.versions/create).",
- "request": {
- "$ref": "GoogleCloudMlV1beta1__Model"
- }
- }
- },
- "resources": {
- "versions": {
- "methods": {
- "list": {
- "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):",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1beta1__ListVersionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path",
- "description": "Required. The name of the model for which to list the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- }
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1beta1__Version"
- },
- "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}",
- "id": "ml.projects.models.versions.get",
- "path": "v1beta1/{+name}",
- "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/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-engine/reference/rest/v1beta1/projects.models.versions/setDefault).",
- "request": {
- "$ref": "GoogleCloudMlV1beta1__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": "v1beta1/projects/{projectsId}/models/{modelsId}/versions",
- "path": "v1beta1/{+parent}/versions",
- "id": "ml.projects.models.versions.create"
- },
- "setDefault": {
- "response": {
- "$ref": "GoogleCloudMlV1beta1__Version"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
- "path": "v1beta1/{+name}:setDefault",
- "id": "ml.projects.models.versions.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."
- },
- "delete": {
- "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version.",
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the version. You can get the names of all the\nversions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/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}",
- "path": "v1beta1/{+name}",
- "id": "ml.projects.models.versions.delete"
- }
- }
- }
- }
- },
- "jobs": {
- "methods": {
- "list": {
- "response": {
- "$ref": "GoogleCloudMlV1beta1__ListJobsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "description": "Optional. Specifies the subset of jobs to retrieve.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Optional. The number of jobs to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "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",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/jobs",
- "path": "v1beta1/{+parent}/jobs",
- "id": "ml.projects.jobs.list",
- "description": "Lists the jobs in the project."
- },
- "get": {
- "description": "Describes a job.",
- "response": {
- "$ref": "GoogleCloudMlV1beta1__Job"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the job to get the description of.\n\nAuthorization: requires `Viewer` role on the parent project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/jobs/{jobsId}",
- "path": "v1beta1/{+name}",
- "id": "ml.projects.jobs.get"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1beta1__Job"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "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."
- },
- "cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "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",
- "id": "ml.projects.jobs.cancel",
- "path": "v1beta1/{+name}:cancel",
- "request": {
- "$ref": "GoogleCloudMlV1beta1__CancelJobRequest"
- },
- "description": "Cancels a running job."
- }
- }
- }
- }
- }
- },
- "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": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://ml.googleapis.com/",
- "servicePath": "",
- "description": "An API to enable creating and using machine learning models.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "id": "ml:v1beta1",
- "revision": "20170509",
- "documentationLink": "https://cloud.google.com/ml/"
+ "ownerName": "Google"
}
diff --git a/ml/v1beta1/ml-gen.go b/ml/v1beta1/ml-gen.go
index 54b872a..c5a1029 100644
--- a/ml/v1beta1/ml-gen.go
+++ b/ml/v1beta1/ml-gen.go
@@ -186,6 +186,11 @@
// Data: HTTP body binary data.
Data string `json:"data,omitempty"`
+ // Extensions: Application specific response metadata. Must be set in
+ // the first response
+ // for streaming APIs.
+ Extensions []googleapi.RawMessage `json:"extensions,omitempty"`
+
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
@@ -213,15 +218,72 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// GoogleCloudMlV1__AutomaticScaling: Options for automatically scaling
+// a model.
+type GoogleCloudMlV1__AutomaticScaling struct {
+ // MinNodes: Optional. The minimum 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 at least
+ // `rate` * `min_nodes` * number of hours since last billing
+ // cycle,
+ // where `rate` is the cost per node-hour as documented
+ // in
+ // [pricing](https://cloud.google.com/ml-engine/pricing#prediction_pri
+ // cing),
+ // even if no predictions are performed. There is additional cost for
+ // each
+ // prediction performed.
+ //
+ // Unlike manual scaling, if the load gets too heavy for the nodes
+ // that are up, the service will automatically add nodes to handle
+ // the
+ // increased load as well as scale back as traffic drops, always
+ // maintaining
+ // at least `min_nodes`. You will be charged for the time in which
+ // additional
+ // nodes are used.
+ //
+ // If not specified, `min_nodes` defaults to 0, in which case, when
+ // traffic
+ // to a model stops (and after a cool-down period), nodes will be shut
+ // down
+ // and no charges will be incurred until traffic to the model resumes.
+ MinNodes int64 `json:"minNodes,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "MinNodes") 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. "MinNodes") 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__AutomaticScaling) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__AutomaticScaling
+ 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
+ // this model will be proportional to `nodes` * number of hours
// since
- // deployment.
+ // last billing cycle plus the cost for each prediction performed.
Nodes int64 `json:"nodes,omitempty"`
// ForceSendFields is a list of field names (e.g. "Nodes") to
@@ -313,6 +375,13 @@
// [projects.models.versions.list](/ml-engine/reference/rest/v1/p
// rojects.models.versions/list).
type GoogleCloudMlV1__Version struct {
+ // AutomaticScaling: Automatically scale the number of nodes used to
+ // serve the model in
+ // response to increases and decreases in traffic. Care should be
+ // taken to ramp up traffic according to the model's ability to scale
+ // or you will start seeing increases in latency and 429 response codes.
+ AutomaticScaling *GoogleCloudMlV1__AutomaticScaling `json:"automaticScaling,omitempty"`
+
// CreateTime: Output only. The time the version was created.
CreateTime string `json:"createTime,omitempty"`
@@ -355,17 +424,17 @@
// 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: Manually select the number of nodes to use for serving
+ // the
+ // model. You should generally use `automatic_scaling` with an
+ // appropriate
+ // `min_nodes` instead, but this option is available if you want
+ // more
+ // predictable billing. Beware that latency and error rates will
+ // increase
+ // if the traffic exceeds that capability of the system to serve it
+ // based
+ // on the selected number of nodes.
ManualScaling *GoogleCloudMlV1__ManualScaling `json:"manualScaling,omitempty"`
// Name: Required.The name specified for the version when it was
@@ -379,7 +448,7 @@
// 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
+ // ForceSendFields is a list of field names (e.g. "AutomaticScaling") 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
@@ -387,12 +456,13 @@
// 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 is a list of field names (e.g. "AutomaticScaling") 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:"-"`
}
@@ -449,6 +519,63 @@
return nil
}
+// GoogleCloudMlV1beta1__AutomaticScaling: Options for automatically
+// scaling a model.
+type GoogleCloudMlV1beta1__AutomaticScaling struct {
+ // MinNodes: Optional. The minimum 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 at least
+ // `rate` * `min_nodes` * number of hours since last billing
+ // cycle,
+ // where `rate` is the cost per node-hour as documented
+ // in
+ // [pricing](https://cloud.google.com/ml-engine/pricing#prediction_pri
+ // cing),
+ // even if no predictions are performed. There is additional cost for
+ // each
+ // prediction performed.
+ //
+ // Unlike manual scaling, if the load gets too heavy for the nodes
+ // that are up, the service will automatically add nodes to handle
+ // the
+ // increased load as well as scale back as traffic drops, always
+ // maintaining
+ // at least `min_nodes`. You will be charged for the time in which
+ // additional
+ // nodes are used.
+ //
+ // If not specified, `min_nodes` defaults to 0, in which case, when
+ // traffic
+ // to a model stops (and after a cool-down period), nodes will be shut
+ // down
+ // and no charges will be incurred until traffic to the model resumes.
+ MinNodes int64 `json:"minNodes,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "MinNodes") 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. "MinNodes") 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__AutomaticScaling) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1beta1__AutomaticScaling
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// GoogleCloudMlV1beta1__CancelJobRequest: Request message for the
// CancelJob method.
type GoogleCloudMlV1beta1__CancelJobRequest struct {
@@ -805,9 +932,9 @@
// 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
+ // this model will be proportional to `nodes` * number of hours
// since
- // deployment.
+ // last billing cycle.
Nodes int64 `json:"nodes,omitempty"`
// ForceSendFields is a list of field names (e.g. "Nodes") to
@@ -1753,6 +1880,13 @@
// [projects.models.versions.list](/ml-engine/reference/rest/v1be
// ta1/projects.models.versions/list).
type GoogleCloudMlV1beta1__Version struct {
+ // AutomaticScaling: Automatically scale the number of nodes used to
+ // serve the model in
+ // response to increases and decreases in traffic. Care should be
+ // taken to ramp up traffic according to the model's ability to scale
+ // or you will start seeing increases in latency and 429 response codes.
+ AutomaticScaling *GoogleCloudMlV1beta1__AutomaticScaling `json:"automaticScaling,omitempty"`
+
// CreateTime: Output only. The time the version was created.
CreateTime string `json:"createTime,omitempty"`
@@ -1795,17 +1929,17 @@
// 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: Manually select the number of nodes to use for serving
+ // the
+ // model. You should generally use `automatic_scaling` with an
+ // appropriate
+ // `min_nodes` instead, but this option is available if you want
+ // predictable
+ // billing. Beware that latency and error rates will increase if
+ // the
+ // traffic exceeds that capability of the system to serve it based
+ // on
+ // the selected number of nodes.
ManualScaling *GoogleCloudMlV1beta1__ManualScaling `json:"manualScaling,omitempty"`
// Name: Required.The name specified for the version when it was
@@ -1823,7 +1957,7 @@
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "CreateTime") to
+ // ForceSendFields is a list of field names (e.g. "AutomaticScaling") 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
@@ -1831,12 +1965,13 @@
// 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 is a list of field names (e.g. "AutomaticScaling") 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:"-"`
}
@@ -2004,7 +2139,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -4821,9 +4956,18 @@
// server doesn't support this method, it returns
// `UNIMPLEMENTED`.
//
-// NOTE: the `name` binding below allows API services to override the
+// NOTE: the `name` binding allows API services to override the
// binding
// to use different resource name schemes, such as `users/*/operations`.
+// To
+// override the binding, API services can add a binding such
+// as
+// "/v1/{name=users/*}/operations" to their service configuration.
+// For backwards compatibility, the default name includes the
+// operations
+// collection id, however overriding users must ensure the name
+// binding
+// is the parent resource, without the operations collection id.
func (r *ProjectsOperationsService) List(name string) *ProjectsOperationsListCall {
c := &ProjectsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -4947,7 +5091,7 @@
}
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`.",
+ // "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
// "flatPath": "v1beta1/projects/{projectsId}/operations",
// "httpMethod": "GET",
// "id": "ml.projects.operations.list",
@@ -4961,7 +5105,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "path",
// "pattern": "^projects/[^/]+$",
// "required": true,
diff --git a/monitoring/v3/monitoring-api.json b/monitoring/v3/monitoring-api.json
index 0097537..e66948d 100644
--- a/monitoring/v3/monitoring-api.json
+++ b/monitoring/v3/monitoring-api.json
@@ -1,1332 +1,10 @@
{
- "rootUrl": "https://monitoring.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "monitoring",
- "batchPath": "batch",
- "title": "Stackdriver Monitoring API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "timeSeries": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListTimeSeriesResponse"
- },
- "parameters": {
- "orderBy": {
- "description": "Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.",
- "type": "string",
- "location": "query"
- },
- "aggregation.crossSeriesReducer": {
- "location": "query",
- "enum": [
- "REDUCE_NONE",
- "REDUCE_MEAN",
- "REDUCE_MIN",
- "REDUCE_MAX",
- "REDUCE_SUM",
- "REDUCE_STDDEV",
- "REDUCE_COUNT",
- "REDUCE_COUNT_TRUE",
- "REDUCE_FRACTION_TRUE",
- "REDUCE_PERCENTILE_99",
- "REDUCE_PERCENTILE_95",
- "REDUCE_PERCENTILE_50",
- "REDUCE_PERCENTILE_05"
- ],
- "description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
- "type": "string"
- },
- "filter": {
- "location": "query",
- "description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "aggregation.perSeriesAligner": {
- "location": "query",
- "enum": [
- "ALIGN_NONE",
- "ALIGN_DELTA",
- "ALIGN_RATE",
- "ALIGN_INTERPOLATE",
- "ALIGN_NEXT_OLDER",
- "ALIGN_MIN",
- "ALIGN_MAX",
- "ALIGN_MEAN",
- "ALIGN_COUNT",
- "ALIGN_SUM",
- "ALIGN_STDDEV",
- "ALIGN_COUNT_TRUE",
- "ALIGN_FRACTION_TRUE",
- "ALIGN_PERCENTILE_99",
- "ALIGN_PERCENTILE_95",
- "ALIGN_PERCENTILE_50",
- "ALIGN_PERCENTILE_05"
- ],
- "description": "The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
- "type": "string"
- },
- "interval.startTime": {
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "view": {
- "description": "Specifies which information is returned about the time series.",
- "type": "string",
- "location": "query",
- "enum": [
- "FULL",
- "HEADERS"
- ]
- },
- "aggregation.groupByFields": {
- "location": "query",
- "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
- "type": "string",
- "repeated": true
- },
- "name": {
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "interval.endTime": {
- "description": "Required. The end of the time interval.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "aggregation.alignmentPeriod": {
- "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
- "format": "google-duration",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "flatPath": "v3/projects/{projectsId}/timeSeries",
- "id": "monitoring.projects.timeSeries.list",
- "path": "v3/{+name}/timeSeries",
- "description": "Lists time series that match a filter. This method does not require a Stackdriver account."
- },
- "create": {
- "request": {
- "$ref": "CreateTimeSeriesRequest"
- },
- "description": "Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "flatPath": "v3/projects/{projectsId}/timeSeries",
- "id": "monitoring.projects.timeSeries.create",
- "path": "v3/{+name}/timeSeries"
- }
- }
- },
- "metricDescriptors": {
- "methods": {
- "delete": {
- "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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": {
- "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListMetricDescriptorsResponse"
- },
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:\nmetric.type = starts_with(\"custom.googleapis.com/\")\n",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "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}/metricDescriptors",
- "id": "monitoring.projects.metricDescriptors.list",
- "path": "v3/{+name}/metricDescriptors"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "MetricDescriptor"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.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}",
- "id": "monitoring.projects.metricDescriptors.get",
- "path": "v3/{+name}",
- "description": "Gets a single metric descriptor. This method does not require a Stackdriver account."
- },
- "create": {
- "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.",
- "request": {
- "$ref": "MetricDescriptor"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "MetricDescriptor"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "parameters": {
- "name": {
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v3/projects/{projectsId}/metricDescriptors",
- "id": "monitoring.projects.metricDescriptors.create",
- "path": "v3/{+name}/metricDescriptors"
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "parameters": {
- "filter": {
- "location": "query",
- "description": "An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:\nresource.type = starts_with(\"gce_\") AND resource.label:id\n",
- "type": "string"
- },
- "name": {
- "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/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors",
- "id": "monitoring.projects.monitoredResourceDescriptors.list",
- "path": "v3/{+name}/monitoredResourceDescriptors"
- },
- "get": {
- "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.monitoredResourceDescriptors.get",
- "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account.",
- "response": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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/[^/]+$"
- }
- },
- "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"
- ]
- }
- }
- },
- "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": {
- "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": {
- "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.",
- "type": "string",
- "location": "query"
- },
- "descendantsOfGroup": {
- "location": "query",
- "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.",
- "type": "string"
- },
- "pageToken": {
- "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"
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups",
- "path": "v3/{+name}/groups",
- "id": "monitoring.projects.groups.list",
- "description": "Lists the existing groups."
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "parameters": {
- "name": {
- "description": "The group to retrieve. 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}",
- "id": "monitoring.projects.groups.get",
- "path": "v3/{+name}",
- "description": "Gets a single group."
- },
- "update": {
- "description": "Updates an existing group. You can change any group attributes except name.",
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "parameters": {
- "name": {
- "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"
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.update"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Group"
- },
- "parameters": {
- "name": {
- "description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "validateOnly": {
- "location": "query",
- "description": "If true, validate this request but do not create the group.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/groups",
- "id": "monitoring.projects.groups.create",
- "path": "v3/{+name}/groups",
- "request": {
- "$ref": "Group"
- },
- "description": "Creates a new group."
- },
- "delete": {
- "description": "Deletes an existing group.",
- "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"
- }
- },
- "resources": {
- "members": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListGroupMembersResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "interval.endTime": {
- "description": "Required. The end of the time interval.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "interval.startTime": {
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer"
- },
- "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/[^/]+$"
- }
- },
- "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": {
- "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",
- "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"
- ]
- }
- }
- }
- }
- }
- },
- "parameters": {
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API 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"
- },
- "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": "v3",
- "baseUrl": "https://monitoring.googleapis.com/",
- "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",
- "servicePath": "",
- "basePath": "",
- "id": "monitoring:v3",
+ "revision": "20170530",
"documentationLink": "https://cloud.google.com/monitoring/api/",
- "revision": "20170506",
+ "id": "monitoring:v3",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "Exponential": {
- "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
- "type": "object",
- "properties": {
- "numFiniteBuckets": {
- "description": "Must be greater than 0.",
- "format": "int32",
- "type": "integer"
- },
- "growthFactor": {
- "description": "Must be greater than 1.",
- "format": "double",
- "type": "number"
- },
- "scale": {
- "description": "Must be greater than 0.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Exponential"
- },
- "Point": {
- "description": "A single data point in a time series.",
- "type": "object",
- "properties": {
- "interval": {
- "$ref": "TimeInterval",
- "description": "The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
- },
- "value": {
- "$ref": "TypedValue",
- "description": "The value of the data point."
- }
- },
- "id": "Point"
- },
- "Field": {
- "description": "A single field of a message type.",
- "type": "object",
- "properties": {
- "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"
- ]
- },
- "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 types. The first type has index 1; zero means the type is not in the list.",
- "format": "int32",
- "type": "integer"
- },
- "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"
- ]
- },
- "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"
- },
- "Metric": {
- "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.",
- "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"
- },
- "LabelDescriptor": {
- "description": "A description of a label.",
- "type": "object",
- "properties": {
- "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"
- ]
- },
- "key": {
- "description": "The label key.",
- "type": "string"
- }
- },
- "id": "LabelDescriptor"
- },
- "ListTimeSeriesResponse": {
- "description": "The ListTimeSeries response.",
- "type": "object",
- "properties": {
- "timeSeries": {
- "description": "One or more time series that match the filter included in the request.",
- "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"
- }
- },
- "id": "ListTimeSeriesResponse"
- },
- "Group": {
- "description": "The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: \"environment\" and \"role\". A parent group has a filter, environment=\"production\". A child of that parent group has a filter, role=\"transcoder\". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.",
- "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"
- },
- "Type": {
- "description": "A protocol buffer message type.",
- "type": "object",
- "properties": {
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "fields": {
- "description": "The list of fields.",
- "type": "array",
- "items": {
- "$ref": "Field"
- }
- },
- "name": {
- "description": "The fully qualified message name.",
- "type": "string"
- },
- "oneofs": {
- "description": "The list of types appearing in oneof definitions in this type.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "syntax": {
- "enumDescriptions": [
- "Syntax proto2.",
- "Syntax proto3."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string"
- }
- },
- "id": "Type"
- },
- "BucketOptions": {
- "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
- "type": "object",
- "properties": {
- "linearBuckets": {
- "$ref": "Linear",
- "description": "The linear bucket."
- },
- "explicitBuckets": {
- "description": "The explicit buckets.",
- "$ref": "Explicit"
- },
- "exponentialBuckets": {
- "description": "The exponential buckets.",
- "$ref": "Exponential"
- }
- },
- "id": "BucketOptions"
- },
- "CollectdValue": {
- "description": "A single data point from a collectd-based plugin.",
- "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"
- },
- "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": {
- "min": {
- "description": "The minimum of the population values.",
- "format": "double",
- "type": "number"
- },
- "max": {
- "description": "The maximum of the population values.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Range"
- },
- "ListGroupsResponse": {
- "description": "The ListGroups response.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
- "type": "string"
- },
- "group": {
- "description": "The groups that match the specified filters.",
- "type": "array",
- "items": {
- "$ref": "Group"
- }
- }
- },
- "id": "ListGroupsResponse"
- },
- "CreateCollectdTimeSeriesRequest": {
- "description": "The CreateCollectdTimeSeries request.",
- "type": "object",
- "properties": {
- "resource": {
- "$ref": "MonitoredResource",
- "description": "The monitored resource associated with the time series."
- },
- "collectdPayloads": {
- "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
- "type": "array",
- "items": {
- "$ref": "CollectdPayload"
- }
- },
- "collectdVersion": {
- "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
- "type": "string"
- }
- },
- "id": "CreateCollectdTimeSeriesRequest"
- },
- "ListGroupMembersResponse": {
- "description": "The ListGroupMembers response.",
- "type": "object",
- "properties": {
- "members": {
- "description": "A set of monitored resources in the group.",
- "type": "array",
- "items": {
- "$ref": "MonitoredResource"
- }
- },
- "nextPageToken": {
- "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
- "type": "string"
- },
- "totalSize": {
- "description": "The total number of elements matching this request.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListGroupMembersResponse"
- },
- "ListMonitoredResourceDescriptorsResponse": {
- "description": "The ListMonitoredResourceDescriptors response.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
- "type": "string"
- },
- "resourceDescriptors": {
- "description": "The monitored resource descriptors that are available to this project and that match filter, if present.",
- "type": "array",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- }
- }
- },
- "id": "ListMonitoredResourceDescriptorsResponse"
- },
- "TimeSeries": {
- "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.",
- "type": "object",
- "properties": {
- "metric": {
- "$ref": "Metric",
- "description": "The associated metric. A fully-specified metric used to identify the time series."
- },
- "points": {
- "description": "The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.",
- "type": "array",
- "items": {
- "$ref": "Point"
- }
- },
- "valueType": {
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
- "The value is a Distribution.",
- "The value is money."
- ],
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ],
- "description": "The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.",
- "type": "string"
- },
- "resource": {
- "$ref": "MonitoredResource",
- "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data."
- },
- "metricKind": {
- "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "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"
- ]
- }
- },
- "id": "TimeSeries"
- },
"CreateTimeSeriesRequest": {
"description": "The CreateTimeSeries request.",
"type": "object",
@@ -1342,9 +20,24 @@
"id": "CreateTimeSeriesRequest"
},
"Distribution": {
+ "id": "Distribution",
"description": "Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.",
"type": "object",
"properties": {
+ "range": {
+ "$ref": "Range",
+ "description": "If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3."
+ },
+ "count": {
+ "type": "string",
+ "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided.",
+ "format": "int64"
+ },
+ "mean": {
+ "description": "The arithmetic mean of the values in the population. If count is zero then this field must be zero.",
+ "format": "double",
+ "type": "number"
+ },
"bucketCounts": {
"description": "Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.",
"type": "array",
@@ -1354,45 +47,30 @@
}
},
"bucketOptions": {
- "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.",
- "$ref": "BucketOptions"
+ "$ref": "BucketOptions",
+ "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries."
},
"sumOfSquaredDeviation": {
"description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is:\nSum[i=1..n]((x_i - mean)^2)\nKnuth, \"The Art of Computer Programming\", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.",
"format": "double",
"type": "number"
- },
- "range": {
- "$ref": "Range",
- "description": "If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3."
- },
- "count": {
- "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided.",
- "format": "int64",
- "type": "string"
- },
- "mean": {
- "description": "The arithmetic mean of the values in the population. If count is zero then this field must be zero.",
- "format": "double",
- "type": "number"
}
- },
- "id": "Distribution"
+ }
},
"MonitoredResource": {
"description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
"type": "object",
"properties": {
+ "type": {
+ "type": "string",
+ "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance."
+ },
"labels": {
- "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
- },
- "type": {
- "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
- "type": "string"
+ },
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
+ "type": "object"
}
},
"id": "MonitoredResource"
@@ -1402,15 +80,15 @@
"type": "object",
"properties": {
"metricDescriptors": {
- "description": "The metric descriptors that are available to the project and that match the value of filter, if present.",
"type": "array",
"items": {
"$ref": "MetricDescriptor"
- }
+ },
+ "description": "The metric descriptors that are available to the project and that match the value of filter, if present."
},
"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."
}
},
"id": "ListMetricDescriptorsResponse"
@@ -1427,8 +105,8 @@
}
},
"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"
+ "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": {
"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\".",
@@ -1478,13 +156,6 @@
"description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
"type": "object",
"properties": {
- "values": {
- "description": "The measured values during this time interval. Each value must have a different dataSourceName.",
- "type": "array",
- "items": {
- "$ref": "CollectdValue"
- }
- },
"typeInstance": {
"description": "The measurement type instance. Example: \"used\".",
"type": "string"
@@ -1505,23 +176,31 @@
"type": "string"
},
"pluginInstance": {
- "description": "The instance name of the plugin Example: \"hdcl\".",
- "type": "string"
+ "type": "string",
+ "description": "The instance name of the plugin Example: \"hdcl\"."
},
"endTime": {
+ "type": "string",
"description": "The end time of the interval.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"startTime": {
+ "type": "string",
"description": "The start time of the interval.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
+ },
+ "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": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
"type": "object",
"properties": {
@@ -1540,8 +219,26 @@
"format": "double",
"type": "number"
}
+ }
+ },
+ "Option": {
+ "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, \"map_entry\". For custom options, it should be the fully-qualified name. For example, \"google.api.http\".",
+ "type": "string"
+ },
+ "value": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.",
+ "type": "object"
+ }
},
- "id": "Linear"
+ "id": "Option"
},
"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 {}.",
@@ -1549,25 +246,6 @@
"properties": {},
"id": "Empty"
},
- "Option": {
- "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
- "type": "object",
- "properties": {
- "value": {
- "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",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in 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": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
"type": "object",
@@ -1599,13 +277,589 @@
}
},
"id": "TimeInterval"
+ },
+ "Exponential": {
+ "id": "Exponential",
+ "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
+ "type": "object",
+ "properties": {
+ "scale": {
+ "description": "Must be greater than 0.",
+ "format": "double",
+ "type": "number"
+ },
+ "numFiniteBuckets": {
+ "description": "Must be greater than 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "growthFactor": {
+ "description": "Must be greater than 1.",
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "Point": {
+ "description": "A single data point in a time series.",
+ "type": "object",
+ "properties": {
+ "interval": {
+ "description": "The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.",
+ "$ref": "TimeInterval"
+ },
+ "value": {
+ "description": "The value of the data point.",
+ "$ref": "TypedValue"
+ }
+ },
+ "id": "Point"
+ },
+ "Metric": {
+ "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "type": {
+ "type": "string",
+ "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount."
+ }
+ },
+ "id": "Metric"
+ },
+ "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": {
+ "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"
+ ]
+ },
+ "packed": {
+ "description": "Whether to use alternative packed wire representation.",
+ "type": "boolean"
+ },
+ "defaultValue": {
+ "description": "The string value of the default value of this field. Proto2 syntax only.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "The field name."
+ },
+ "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"
+ },
+ "ListTimeSeriesResponse": {
+ "description": "The ListTimeSeries response.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
+ "type": "string"
+ },
+ "timeSeries": {
+ "description": "One or more time series that match the filter included in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "TimeSeries"
+ }
+ }
+ },
+ "id": "ListTimeSeriesResponse"
+ },
+ "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."
+ },
+ "Type": {
+ "description": "A protocol buffer message type.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The fully qualified message name.",
+ "type": "string"
+ },
+ "oneofs": {
+ "description": "The list of types appearing in oneof definitions in this type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
+ },
+ "syntax": {
+ "description": "The source syntax.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax proto2.",
+ "Syntax proto3."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ]
+ },
+ "options": {
+ "description": "The protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "fields": {
+ "description": "The list of fields.",
+ "type": "array",
+ "items": {
+ "$ref": "Field"
+ }
+ }
+ },
+ "id": "Type"
+ },
+ "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": {
+ "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": {
+ "type": "string",
+ "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, \"\"."
+ },
+ "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"
+ }
+ },
+ "id": "Group"
+ },
+ "BucketOptions": {
+ "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
+ "type": "object",
+ "properties": {
+ "exponentialBuckets": {
+ "description": "The exponential buckets.",
+ "$ref": "Exponential"
+ },
+ "linearBuckets": {
+ "$ref": "Linear",
+ "description": "The linear bucket."
+ },
+ "explicitBuckets": {
+ "$ref": "Explicit",
+ "description": "The explicit buckets."
+ }
+ },
+ "id": "BucketOptions"
+ },
+ "CollectdValue": {
+ "description": "A single data point from a collectd-based plugin.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The measurement value.",
+ "$ref": "TypedValue"
+ },
+ "dataSourceType": {
+ "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"
+ ],
+ "description": "The type of measurement."
+ },
+ "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"
+ },
+ "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": {
+ "type": {
+ "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
+ "type": "string"
+ },
+ "valueType": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a Distribution.",
+ "The value is money."
+ ],
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
+ "type": "string"
+ },
+ "metricKind": {
+ "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": {
+ "type": "string",
+ "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\"."
+ },
+ "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"
+ }
+ },
+ "id": "MetricDescriptor"
+ },
+ "SourceContext": {
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "type": "string",
+ "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\"."
+ }
+ },
+ "id": "SourceContext",
+ "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined."
+ },
+ "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": {
+ "id": "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."
+ }
+ }
+ },
+ "ListGroupMembersResponse": {
+ "description": "The ListGroupMembers response.",
+ "type": "object",
+ "properties": {
+ "totalSize": {
+ "description": "The total number of elements matching this request.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "members": {
+ "description": "A set of monitored resources in the group.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoredResource"
+ }
+ },
+ "nextPageToken": {
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
+ "type": "string"
+ }
+ },
+ "id": "ListGroupMembersResponse"
+ },
+ "CreateCollectdTimeSeriesRequest": {
+ "id": "CreateCollectdTimeSeriesRequest",
+ "description": "The CreateCollectdTimeSeries request.",
+ "type": "object",
+ "properties": {
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "The monitored resource associated with the time series."
+ },
+ "collectdPayloads": {
+ "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectdPayload"
+ }
+ },
+ "collectdVersion": {
+ "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
+ "type": "string"
+ }
+ }
+ },
+ "ListMonitoredResourceDescriptorsResponse": {
+ "description": "The ListMonitoredResourceDescriptors response.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
+ "type": "string"
+ },
+ "resourceDescriptors": {
+ "description": "The monitored resource descriptors that are available to this project and that match filter, if present.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ }
+ }
+ },
+ "id": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "TimeSeries": {
+ "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.",
+ "type": "object",
+ "properties": {
+ "metricKind": {
+ "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
+ ],
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ]
+ },
+ "metric": {
+ "$ref": "Metric",
+ "description": "The associated metric. A fully-specified metric used to identify the time series."
+ },
+ "points": {
+ "description": "The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.",
+ "type": "array",
+ "items": {
+ "$ref": "Point"
+ }
+ },
+ "valueType": {
+ "description": "The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a Distribution.",
+ "The value is money."
+ ],
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ]
+ },
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data."
+ }
+ },
+ "id": "TimeSeries"
}
},
- "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"canonicalName": "Monitoring",
"auth": {
"oauth2": {
@@ -1624,5 +878,751 @@
}
}
}
- }
+ },
+ "rootUrl": "https://monitoring.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "monitoring",
+ "batchPath": "batch",
+ "title": "Stackdriver Monitoring API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "metricDescriptors": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListMetricDescriptorsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:\nmetric.type = starts_with(\"custom.googleapis.com/\")\n",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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": {
+ "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",
+ "description": "Gets a single metric descriptor. This method does not require a Stackdriver account."
+ },
+ "create": {
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "name": {
+ "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"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors",
+ "path": "v3/{+name}/metricDescriptors",
+ "id": "monitoring.projects.metricDescriptors.create",
+ "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.",
+ "request": {
+ "$ref": "MetricDescriptor"
+ }
+ },
+ "delete": {
+ "id": "monitoring.projects.metricDescriptors.delete",
+ "path": "v3/{+name}",
+ "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metricDescriptors/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}"
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "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": {
+ "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}\"."
+ },
+ "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."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors",
+ "id": "monitoring.projects.monitoredResourceDescriptors.list",
+ "path": "v3/{+name}/monitoredResourceDescriptors",
+ "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ }
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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}",
+ "id": "monitoring.projects.monitoredResourceDescriptors.get",
+ "path": "v3/{+name}",
+ "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account."
+ }
+ }
+ },
+ "groups": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing group.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "name": {
+ "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"
+ },
+ "list": {
+ "id": "monitoring.projects.groups.list",
+ "path": "v3/{+name}/groups",
+ "description": "Lists the existing groups.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListGroupsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "descendantsOfGroup": {
+ "type": "string",
+ "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."
+ },
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "ancestorsOfGroup": {
+ "type": "string",
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups"
+ },
+ "get": {
+ "description": "Gets a single group.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Group"
+ },
+ "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": {
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$"
+ },
+ "validateOnly": {
+ "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",
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Updates an existing group. You can change any group attributes except name."
+ },
+ "create": {
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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": {
+ "location": "query",
+ "description": "If true, validate this request but do not create the group.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups",
+ "path": "v3/{+name}/groups",
+ "id": "monitoring.projects.groups.create",
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Creates a new group."
+ }
+ },
+ "resources": {
+ "members": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListGroupMembersResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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": {
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/collectdTimeSeries",
+ "path": "v3/{+name}/collectdTimeSeries",
+ "id": "monitoring.projects.collectdTimeSeries.create",
+ "request": {
+ "$ref": "CreateCollectdTimeSeriesRequest"
+ },
+ "description": "Stackdriver Monitoring Agent only: Creates a new time series.\u003caside class=\"caution\"\u003eThis method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.\u003c/aside\u003e",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST"
+ }
+ }
+ },
+ "timeSeries": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTimeSeriesResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.",
+ "type": "string"
+ },
+ "aggregation.crossSeriesReducer": {
+ "location": "query",
+ "enum": [
+ "REDUCE_NONE",
+ "REDUCE_MEAN",
+ "REDUCE_MIN",
+ "REDUCE_MAX",
+ "REDUCE_SUM",
+ "REDUCE_STDDEV",
+ "REDUCE_COUNT",
+ "REDUCE_COUNT_TRUE",
+ "REDUCE_FRACTION_TRUE",
+ "REDUCE_PERCENTILE_99",
+ "REDUCE_PERCENTILE_95",
+ "REDUCE_PERCENTILE_50",
+ "REDUCE_PERCENTILE_05"
+ ],
+ "description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
+ "type": "string"
+ },
+ "filter": {
+ "description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string"
+ },
+ "aggregation.perSeriesAligner": {
+ "location": "query",
+ "enum": [
+ "ALIGN_NONE",
+ "ALIGN_DELTA",
+ "ALIGN_RATE",
+ "ALIGN_INTERPOLATE",
+ "ALIGN_NEXT_OLDER",
+ "ALIGN_MIN",
+ "ALIGN_MAX",
+ "ALIGN_MEAN",
+ "ALIGN_COUNT",
+ "ALIGN_SUM",
+ "ALIGN_STDDEV",
+ "ALIGN_COUNT_TRUE",
+ "ALIGN_FRACTION_TRUE",
+ "ALIGN_PERCENTILE_99",
+ "ALIGN_PERCENTILE_95",
+ "ALIGN_PERCENTILE_50",
+ "ALIGN_PERCENTILE_05"
+ ],
+ "description": "The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
+ "type": "string"
+ },
+ "interval.startTime": {
+ "location": "query",
+ "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "view": {
+ "description": "Specifies which information is returned about the time series.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "FULL",
+ "HEADERS"
+ ]
+ },
+ "aggregation.groupByFields": {
+ "repeated": true,
+ "location": "query",
+ "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "interval.endTime": {
+ "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"
+ }
+ },
+ "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",
+ "id": "monitoring.projects.timeSeries.list",
+ "path": "v3/{+name}/timeSeries",
+ "description": "Lists time series that match a filter. This method does not require a Stackdriver account."
+ },
+ "create": {
+ "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": {
+ "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}\"."
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/timeSeries"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ }
+ },
+ "version": "v3",
+ "baseUrl": "https://monitoring.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/partners/v2/partners-api.json b/partners/v2/partners-api.json
index 1d3fe79..c5d3bb4 100644
--- a/partners/v2/partners-api.json
+++ b/partners/v2/partners-api.json
@@ -1,273 +1,58 @@
{
- "revision": "20170503",
- "documentationLink": "https://developers.google.com/partners/",
- "id": "partners:v2",
- "title": "Google Partners API",
"ownerName": "Google",
"discoveryVersion": "v1",
"version_module": "True",
"resources": {
- "users": {
- "methods": {
- "createCompanyRelation": {
- "parameters": {
- "requestMetadata.trafficSource.trafficSubId": {
- "type": "string",
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
- },
- "userId": {
- "location": "path",
- "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
- "required": true,
- "type": "string"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "type": "string",
- "location": "query",
- "description": "Google Partners session ID."
- },
- "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": {
- "type": "string",
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to."
- }
- },
- "flatPath": "v2/users/{userId}/companyRelation",
- "id": "partners.users.createCompanyRelation",
- "path": "v2/users/{userId}/companyRelation",
- "description": "Creates a user's company relation. Affiliates the user to a company.",
- "request": {
- "$ref": "CompanyRelation"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "CompanyRelation"
- }
- },
- "deleteCompanyRelation": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "type": "string",
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
- },
- "userId": {
- "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.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- }
- },
- "flatPath": "v2/users/{userId}/companyRelation",
- "id": "partners.users.deleteCompanyRelation",
- "path": "v2/users/{userId}/companyRelation",
- "description": "Deletes a user's company relation. Unaffiliaites the user from a company."
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "User"
- },
- "parameters": {
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
- },
- "userView": {
- "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": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "userId": {
- "location": "path",
- "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2/users/{userId}",
- "id": "partners.users.get",
- "path": "v2/users/{userId}",
- "description": "Gets a user."
- },
- "updateProfile": {
- "httpMethod": "PATCH",
- "parameterOrder": [],
- "response": {
- "$ref": "UserProfile"
- },
- "parameters": {
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
- },
- "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.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "type": "string",
- "location": "query",
- "description": "Google Partners session ID."
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "type": "string",
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
- }
- },
- "flatPath": "v2/users/profile",
- "id": "partners.users.updateProfile",
- "path": "v2/users/profile",
- "request": {
- "$ref": "UserProfile"
- },
- "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user."
- }
- }
- },
"companies": {
"methods": {
"get": {
+ "path": "v2/companies/{companyId}",
+ "id": "partners.companies.get",
"description": "Gets a company.",
- "httpMethod": "GET",
- "parameterOrder": [
- "companyId"
- ],
"response": {
"$ref": "GetCompanyResponse"
},
+ "parameterOrder": [
+ "companyId"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "requestMetadata.partnersSessionId": {
+ "companyId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the company to retrieve."
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "currencyCode": {
"location": "query",
- "description": "Google Partners session ID.",
+ "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "How to order addresses within the returned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
"type": "string"
},
"requestMetadata.userOverrides.userId": {
+ "type": "string",
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
},
"view": {
"location": "query",
@@ -278,15 +63,15 @@
"description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
"type": "string"
},
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
- },
"address": {
+ "type": "string",
"location": "query",
- "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.",
- "type": "string"
+ "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."
+ },
+ "requestMetadata.locale": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
},
"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.",
@@ -297,47 +82,19 @@
"location": "query",
"description": "IP address to use instead of the user's geo-located IP address.",
"type": "string"
- },
- "companyId": {
- "location": "path",
- "description": "The ID of the company to retrieve.",
- "required": true,
- "type": "string"
- },
- "currencyCode": {
- "location": "query",
- "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
- },
- "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": {
- "type": "string",
- "location": "query",
- "description": "How to order addresses within the returned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively."
}
},
- "flatPath": "v2/companies/{companyId}",
- "id": "partners.companies.get",
- "path": "v2/companies/{companyId}"
+ "flatPath": "v2/companies/{companyId}"
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "ListCompaniesResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
"specializations": {
+ "location": "query",
"enum": [
"BADGE_SPECIALIZATION_UNKNOWN",
"BADGE_SPECIALIZATION_ADWORDS_SEARCH",
@@ -348,18 +105,17 @@
],
"description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.",
"type": "string",
- "repeated": true,
- "location": "query"
+ "repeated": true
},
"maxMonthlyBudget.currencyCode": {
- "type": "string",
"location": "query",
- "description": "The 3-letter currency code defined in ISO 4217."
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string"
},
"minMonthlyBudget.currencyCode": {
+ "location": "query",
"description": "The 3-letter currency code defined in ISO 4217.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.userOverrides.userId": {
"location": "query",
@@ -367,37 +123,38 @@
"type": "string"
},
"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": {
+ ],
+ "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
"type": "string",
- "location": "query",
- "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used."
+ "location": "query"
},
"requestMetadata.locale": {
- "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "address": {
+ "location": "query",
+ "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.",
+ "type": "string"
+ },
+ "minMonthlyBudget.units": {
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
"type": "string",
"location": "query"
},
- "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",
- "location": "query"
+ "type": "integer"
},
"services": {
+ "location": "query",
"enum": [
"SERVICE_UNSPECIFIED",
"S_ADVANCED_ADWORDS_SUPPORT",
@@ -409,19 +166,23 @@
],
"description": "List of services that the returned agencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializations\" field.",
"type": "string",
- "repeated": true,
- "location": "query"
- },
- "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"
+ "repeated": true
},
"maxMonthlyBudget.units": {
+ "location": "query",
"description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
"format": "int64",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ },
+ "requestMetadata.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": {
"location": "query",
@@ -429,29 +190,22 @@
"format": "int32",
"type": "integer"
},
- "requestMetadata.trafficSource.trafficSubId": {
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
"requestMetadata.partnersSessionId": {
"location": "query",
"description": "Google Partners session ID.",
"type": "string"
},
- "companyName": {
- "description": "Company name to search for.",
- "type": "string",
- "location": "query"
- },
"pageToken": {
"location": "query",
"description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies.",
"type": "string"
},
- "industries": {
+ "companyName": {
"type": "string",
- "repeated": true,
+ "location": "query",
+ "description": "Company name to search for."
+ },
+ "industries": {
"location": "query",
"enum": [
"INDUSTRY_UNSPECIFIED",
@@ -466,31 +220,33 @@
"I_TECHNOLOGY",
"I_TRAVEL"
],
- "description": "List of industries the company can help with."
+ "description": "List of industries the company can help with.",
+ "type": "string",
+ "repeated": true
},
"websiteUrl": {
+ "type": "string",
"location": "query",
- "description": "Website URL that will help to find a better matched company.\n.",
- "type": "string"
+ "description": "Website URL that will help to find a better matched company.\n."
},
"gpsMotivations": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
"enum": [
"GPS_MOTIVATION_UNSPECIFIED",
"GPSM_HELP_WITH_ADVERTISING",
"GPSM_HELP_WITH_WEBSITE",
"GPSM_NO_WEBSITE"
],
- "description": "List of reasons for using Google Partner Search to get companies.",
+ "description": "List of reasons for using Google Partner Search to get companies."
+ },
+ "languageCodes": {
+ "description": "List of language codes that company can support. Only primary language\nsubtags are accepted as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
"type": "string",
"repeated": true,
"location": "query"
},
- "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": {
"description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
"format": "int32",
@@ -503,10 +259,10 @@
"location": "query"
},
"requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
"type": "string",
"repeated": true,
- "location": "query"
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
},
"orderBy": {
"location": "query",
@@ -515,8 +271,8 @@
}
},
"flatPath": "v2/companies",
- "id": "partners.companies.list",
"path": "v2/companies",
+ "id": "partners.companies.list",
"description": "Lists companies."
}
},
@@ -524,6 +280,17 @@
"leads": {
"methods": {
"create": {
+ "request": {
+ "$ref": "CreateLeadRequest"
+ },
+ "description": "Creates an advertiser lead for the given company ID.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "companyId"
+ ],
+ "response": {
+ "$ref": "CreateLeadResponse"
+ },
"parameters": {
"companyId": {
"description": "The ID of the company to contact.",
@@ -533,144 +300,92 @@
}
},
"flatPath": "v2/companies/{companyId}/leads",
- "path": "v2/companies/{companyId}/leads",
"id": "partners.companies.leads.create",
- "description": "Creates an advertiser lead for the given company ID.",
- "request": {
- "$ref": "CreateLeadRequest"
- },
- "response": {
- "$ref": "CreateLeadResponse"
- },
- "parameterOrder": [
- "companyId"
- ],
- "httpMethod": "POST"
+ "path": "v2/companies/{companyId}/leads"
}
}
}
}
},
- "userEvents": {
+ "users": {
"methods": {
- "log": {
- "response": {
- "$ref": "LogUserEventResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "flatPath": "v2/userEvents:log",
- "path": "v2/userEvents:log",
- "id": "partners.userEvents.log",
- "description": "Logs a user event.",
- "request": {
- "$ref": "LogUserEventRequest"
- }
- }
- }
- },
- "clientMessages": {
- "methods": {
- "log": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "LogMessageResponse"
- },
- "parameters": {},
- "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"
- }
- }
- }
- },
- "exams": {
- "methods": {
- "getToken": {
- "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System",
- "response": {
- "$ref": "ExamToken"
- },
- "parameterOrder": [
- "examType"
- ],
+ "get": {
"httpMethod": "GET",
+ "parameterOrder": [
+ "userId"
+ ],
+ "response": {
+ "$ref": "User"
+ },
"parameters": {
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "requestMetadata.experimentIds": {
"type": "string",
- "location": "query"
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
},
- "examType": {
- "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"
- ],
- "description": "The exam type we are requesting a token for.",
+ "userId": {
+ "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.",
"required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
},
"requestMetadata.userOverrides.userId": {
- "location": "query",
"description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.partnersSessionId": {
+ "type": "string",
"location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
+ "description": "Google Partners session ID."
+ },
+ "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.",
+ "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.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
"type": "string",
- "repeated": true,
- "location": "query"
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address."
}
},
- "flatPath": "v2/exams/{examType}/token",
- "path": "v2/exams/{examType}/token",
- "id": "partners.exams.getToken"
- }
- }
- },
- "leads": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLeadsResponse"
+ "flatPath": "v2/users/{userId}",
+ "id": "partners.users.get",
+ "path": "v2/users/{userId}",
+ "description": "Gets a user."
+ },
+ "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"
},
+ "httpMethod": "PATCH",
"parameterOrder": [],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "UserProfile"
+ },
"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.",
@@ -693,36 +408,317 @@
"type": "string",
"repeated": true
},
- "orderBy": {
- "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
+ "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/users/profile",
+ "id": "partners.users.updateProfile",
+ "path": "v2/users/profile"
+ },
+ "createCompanyRelation": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "userId"
+ ],
+ "response": {
+ "$ref": "CompanyRelation"
+ },
+ "parameters": {
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address."
+ },
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ },
+ "userId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user."
+ },
+ "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": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/users/{userId}/companyRelation",
+ "id": "partners.users.createCompanyRelation",
+ "path": "v2/users/{userId}/companyRelation",
+ "description": "Creates a user's company relation. Affiliates the user to a company.",
+ "request": {
+ "$ref": "CompanyRelation"
+ }
+ },
+ "deleteCompanyRelation": {
+ "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "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": {
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true
+ },
+ "userId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user."
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/users/{userId}/companyRelation",
+ "path": "v2/users/{userId}/companyRelation",
+ "id": "partners.users.deleteCompanyRelation"
+ }
+ }
+ },
+ "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": {
+ "response": {
+ "$ref": "LogMessageResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v2/clientMessages:log",
+ "path": "v2/clientMessages:log",
+ "id": "partners.clientMessages.log",
+ "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc.",
+ "request": {
+ "$ref": "LogMessageRequest"
+ }
+ }
+ }
+ },
+ "exams": {
+ "methods": {
+ "getToken": {
+ "flatPath": "v2/exams/{examType}/token",
+ "id": "partners.exams.getToken",
+ "path": "v2/exams/{examType}/token",
+ "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": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "type": "string",
+ "location": "query",
+ "description": "Google Partners session ID."
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "type": "string",
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address."
+ },
+ "requestMetadata.experimentIds": {
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "leads": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLeadsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "type": "string",
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "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": {
+ "description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "type": "string",
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
"requestMetadata.trafficSource.trafficSubId": {
"type": "string",
"location": "query",
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.userOverrides.userId": {
+ "orderBy": {
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
"type": "string"
- },
- "pageToken": {
- "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListLeadsResponse.next_page_token`\nreturned from the previous call to\nListLeads.",
- "type": "string",
- "location": "query"
- },
- "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"
}
},
"flatPath": "v2/leads",
@@ -735,20 +731,19 @@
"offers": {
"methods": {
"list": {
- "description": "Lists the Offers available for the current user",
+ "parameterOrder": [],
"response": {
"$ref": "ListOffersResponse"
},
"httpMethod": "GET",
- "parameterOrder": [],
"parameters": {
- "requestMetadata.userOverrides.userId": {
+ "requestMetadata.partnersSessionId": {
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "description": "Google Partners session ID.",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string",
"location": "query"
},
@@ -763,15 +758,15 @@
"type": "string"
},
"requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
"description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
"repeated": true,
- "location": "query"
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
},
"requestMetadata.trafficSource.trafficSubId": {
"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.",
@@ -781,7 +776,8 @@
},
"flatPath": "v2/offers",
"path": "v2/offers",
- "id": "partners.offers.list"
+ "id": "partners.offers.list",
+ "description": "Lists the Offers available for the current user"
}
},
"resources": {
@@ -791,18 +787,18 @@
"response": {
"$ref": "ListOffersHistoryResponse"
},
- "httpMethod": "GET",
"parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
"requestMetadata.userOverrides.userId": {
- "type": "string",
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID."
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
},
"requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Google Partners session ID."
},
"pageToken": {
"location": "query",
@@ -810,10 +806,10 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "Maximum number of rows to return per page.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"requestMetadata.trafficSource.trafficSourceId": {
"type": "string",
@@ -826,30 +822,30 @@
"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": {
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
"type": "string",
- "location": "query"
+ "repeated": true
},
"entireCompany": {
"description": "if true, show history for the entire company. Requires user to be admin.",
"type": "boolean",
"location": "query"
},
- "requestMetadata.experimentIds": {
+ "orderBy": {
"type": "string",
- "repeated": true,
"location": "query",
- "description": "Experiment IDs the current request belongs to."
+ "description": "Comma-separated list of fields to order by, e.g.: \"foo,bar,baz\".\nUse \"foo desc\" to sort descending.\nList of valid field names is: name, offer_code, expiration_time, status,\n last_modified_time, sender_name, creation_time, country_code,\n offer_type."
},
"requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "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"
+ "type": "string"
}
},
"flatPath": "v2/offers/history",
@@ -861,18 +857,40 @@
}
}
},
- "analytics": {
+ "userStates": {
"methods": {
"list": {
- "id": "partners.analytics.list",
- "path": "v2/analytics",
- "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
- "httpMethod": "GET",
- "parameterOrder": [],
"response": {
- "$ref": "ListAnalyticsResponse"
+ "$ref": "ListUserStatesResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
"requestMetadata.experimentIds": {
"description": "Experiment IDs the current request belongs to.",
"type": "string",
@@ -883,21 +901,38 @@
"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/userStates",
+ "path": "v2/userStates",
+ "id": "partners.userStates.list",
+ "description": "Lists states for current user."
+ }
+ }
+ },
+ "analytics": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListAnalyticsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
"requestMetadata.userOverrides.userId": {
- "type": "string",
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID."
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
},
"requestMetadata.partnersSessionId": {
+ "type": "string",
"location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
+ "description": "Google Partners session ID."
},
"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"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -919,62 +954,23 @@
"location": "query",
"description": "IP address to use instead of the user's geo-located IP address.",
"type": "string"
- }
- },
- "flatPath": "v2/analytics"
- }
- }
- },
- "userStates": {
- "methods": {
- "list": {
- "path": "v2/userStates",
- "id": "partners.userStates.list",
- "description": "Lists states for current user.",
- "response": {
- "$ref": "ListUserStatesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
+ },
"requestMetadata.experimentIds": {
+ "location": "query",
"description": "Experiment IDs the current request belongs to.",
"type": "string",
- "repeated": true,
- "location": "query"
+ "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",
- "location": "query"
- },
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
"type": "string"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
}
},
- "flatPath": "v2/userStates"
+ "flatPath": "v2/analytics",
+ "path": "v2/analytics",
+ "id": "partners.analytics.list",
+ "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user."
}
}
},
@@ -987,6 +983,91 @@
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/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": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
+ "format": "google-fieldmask"
+ },
+ "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": {
"description": "Google Partners session ID.",
"type": "string",
@@ -996,150 +1077,65 @@
"type": "string",
"location": "query",
"description": "Logged-in user ID to impersonate instead of the user's ID."
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "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"
- }
- },
- "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": {
- "response": {
- "$ref": "Lead"
- },
- "parameterOrder": [],
- "httpMethod": "PATCH",
- "parameters": {
- "requestMetadata.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "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": {
- "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"
}
},
"flatPath": "v2/leads",
- "path": "v2/leads",
"id": "partners.updateLeads",
- "description": "Updates the specified lead.",
- "request": {
- "$ref": "Lead"
- }
+ "path": "v2/leads"
},
"updateCompanies": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [],
"response": {
"$ref": "Company"
},
- "parameterOrder": [],
- "httpMethod": "PATCH",
"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": {
- "type": "string",
"location": "query",
- "description": "Locale to use for the current request."
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
+ "description": "Locale to use for the current request.",
"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",
+ "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",
- "description": "Experiment IDs the current request belongs to."
+ "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": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ "description": "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/companies",
- "path": "v2/companies",
"id": "partners.updateCompanies",
+ "path": "v2/companies",
"request": {
"$ref": "Company"
},
@@ -1149,45 +1145,54 @@
}
},
"parameters": {
- "pp": {
- "type": "boolean",
- "default": "true",
+ "quotaUser": {
"location": "query",
- "description": "Pretty-print response."
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "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"
},
- "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": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
- },
- "uploadType": {
+ "default": "true",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "description": "Returns response with indentations and line breaks."
},
"fields": {
- "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1197,14 +1202,16 @@
"1",
"2"
],
- "description": "V1 error format."
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "description": "V1 error format.",
+ "type": "string"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1212,1128 +1219,32 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
+ "default": "json"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
- "quotaUser": {
+ "access_token": {
+ "type": "string",
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "description": "OAuth access token."
}
},
"schemas": {
- "EventData": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Action data.",
- "Agency ID data.",
- "Agency name data.",
- "Agency phone number data.",
- "Agency website data.",
- "Budget data.",
- "Center-point data.",
- "Certification data.",
- "Comment data.",
- "Country data.",
- "Currency data.",
- "Currently viewed agency ID data.",
- "Distance data.",
- "Distance type data.",
- "Exam data.",
- "History token data.",
- "Identifier data.",
- "Industry data.",
- "Insight tag data.",
- "Language data.",
- "Location data.",
- "Marketing opt-in data.",
- "Query data.",
- "Search start index data.",
- "Service data.",
- "Show vow data.",
- "Solution data.",
- "Traffic source ID data.",
- "Traffic sub ID data.",
- "Viewport data.",
- "Website data.",
- "Details data.",
- "Experiment ID data.",
- "Google Partner Search motivation data.",
- "URL data.",
- "Element we wanted user to focus on.",
- "Progress when viewing an item \\[0-100\\]."
- ],
- "enum": [
- "EVENT_DATA_TYPE_UNSPECIFIED",
- "ACTION",
- "AGENCY_ID",
- "AGENCY_NAME",
- "AGENCY_PHONE_NUMBER",
- "AGENCY_WEBSITE",
- "BUDGET",
- "CENTER_POINT",
- "CERTIFICATION",
- "COMMENT",
- "COUNTRY",
- "CURRENCY",
- "CURRENTLY_VIEWED_AGENCY_ID",
- "DISTANCE",
- "DISTANCE_TYPE",
- "EXAM",
- "HISTORY_TOKEN",
- "ID",
- "INDUSTRY",
- "INSIGHT_TAG",
- "LANGUAGE",
- "LOCATION",
- "MARKETING_OPT_IN",
- "QUERY",
- "SEARCH_START_INDEX",
- "SERVICE",
- "SHOW_VOW",
- "SOLUTION",
- "TRAFFIC_SOURCE_ID",
- "TRAFFIC_SUB_ID",
- "VIEW_PORT",
- "WEBSITE",
- "DETAILS",
- "EXPERIMENT_ID",
- "GPS_MOTIVATION",
- "URL",
- "ELEMENT_FOCUS",
- "PROGRESS"
- ],
- "description": "Data type."
- },
- "values": {
- "description": "Data values.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "EventData",
- "description": "Key value data pair for an event."
- },
- "ExamStatus": {
- "description": "A user's information on a specific exam.",
- "type": "object",
- "properties": {
- "examType": {
- "enum": [
- "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
- "CET_ADWORDS_FUNDAMENTALS",
- "CET_ADWORDS_ADVANCED_SEARCH",
- "CET_ADWORDS_ADVANCED_DISPLAY",
- "CET_VIDEO_ADS",
- "CET_DOUBLECLICK",
- "CET_ANALYTICS",
- "CET_SHOPPING",
- "CET_MOBILE",
- "CET_DIGITAL_SALES",
- "CET_MOBILE_SITES"
- ],
- "description": "The type of the exam.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Adwords Fundamentals exam.",
- "AdWords advanced search exam.",
- "AdWords advanced display exam.",
- "VideoAds exam.",
- "DoubleClick exam.",
- "Analytics exam.",
- "Shopping exam.",
- "Mobile exam.",
- "Digital Sales exam.",
- "Mobile Sites exam."
- ]
- },
- "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": {
- "type": "boolean",
- "description": "Whether this exam is in the state of warning."
- },
- "expiration": {
- "type": "string",
- "description": "Date this exam is due to expire.",
- "format": "google-datetime"
- },
- "lastPassed": {
- "description": "The date the user last passed this exam.",
- "format": "google-datetime",
- "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": {
- "type": "array",
- "items": {
- "$ref": "AvailableOffer"
- },
- "description": "Available Offers to be distributed."
- },
- "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": {
- "companies": {
- "description": "The list of companies.",
- "type": "array",
- "items": {
- "$ref": "Company"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.",
- "type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "ListCompaniesResponse"
- },
- "OfferCustomer": {
- "type": "object",
- "properties": {
- "adwordsUrl": {
- "type": "string",
- "description": "URL to the customer's AdWords page."
- },
- "countryCode": {
- "description": "Country code of the customer.",
- "type": "string"
- },
- "creationTime": {
- "description": "Time the customer was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "eligibilityDaysLeft": {
- "description": "Days the customer is still eligible.",
- "format": "int32",
- "type": "integer"
- },
- "offerType": {
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
- "description": "Type of the offer",
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ]
- },
- "externalCid": {
- "description": "External CID for the customer.",
- "format": "int64",
- "type": "string"
- },
- "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",
- "description": "Customers qualified for an offer."
- },
- "CertificationStatus": {
- "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",
- "description": "Google Partners certification status.",
- "type": "object"
- },
- "LocalizedCompanyInfo": {
- "description": "The localized company information.",
- "type": "object",
- "properties": {
- "countryCodes": {
- "description": "List of country codes for the localized company info.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "overview": {
- "description": "Localized brief description that the company uses to advertise themselves.",
- "type": "string"
- },
- "displayName": {
- "description": "Localized display name.",
- "type": "string"
- },
- "languageCode": {
- "description": "Language code of the localized company info, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
- "type": "string"
- }
- },
- "id": "LocalizedCompanyInfo"
- },
- "LogUserEventResponse": {
- "id": "LogUserEventResponse",
- "description": "Response message for\nLogUserEvent.",
- "type": "object",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- }
- },
- "ListOffersHistoryResponse": {
- "description": "Response for ListOfferHistory.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
- "type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "canShowEntireCompany": {
- "type": "boolean",
- "description": "True if the user has the option to show entire company history."
- },
- "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"
- }
- }
- },
- "id": "ListOffersHistoryResponse"
- },
- "LogMessageResponse": {
- "description": "Response message for\nLogClientMessage.",
- "type": "object",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "LogMessageResponse"
- },
- "SpecializationStatus": {
- "type": "object",
- "properties": {
- "badgeSpecialization": {
- "enum": [
- "BADGE_SPECIALIZATION_UNKNOWN",
- "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
- "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
- "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
- "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
- "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
- ],
- "description": "The specialization this status is for.",
- "type": "string",
- "enumDescriptions": [
- "Unknown specialization",
- "AdWords Search specialization",
- "AdWords Display specialization",
- "AdWords Mobile specialization",
- "AdWords Video specialization",
- "AdWords Shopping specialization"
- ]
- },
- "badgeSpecializationState": {
- "description": "State of agency specialization.",
- "type": "string",
- "enumDescriptions": [
- "Unknown state",
- "Specialization passed",
- "Specialization not passed",
- "Specialization in grace"
- ],
- "enum": [
- "BADGE_SPECIALIZATION_STATE_UNKNOWN",
- "BADGE_SPECIALIZATION_STATE_PASSED",
- "BADGE_SPECIALIZATION_STATE_NOT_PASSED",
- "BADGE_SPECIALIZATION_STATE_IN_GRACE"
- ]
- }
- },
- "id": "SpecializationStatus",
- "description": "Agency specialization status"
- },
- "Certification": {
- "description": "A user's information on a specific certification.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "Certification"
- },
- "User": {
- "description": "A resource representing a user of the Partners platform.",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID of the user."
- },
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Information about a user's external public profile outside Google Partners."
- },
- "companyVerificationEmail": {
- "description": "The email address used by the user used for company verification.\n@OutputOnly",
- "type": "string"
- },
- "certificationStatus": {
- "description": "The list of achieved certifications. These are calculated based on exam\nresults and other requirements.\n@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "Certification"
- }
- },
- "company": {
- "$ref": "CompanyRelation",
- "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company."
- },
- "profile": {
- "description": "The profile information of a Partners user, contains all the directly\neditable user information.",
- "$ref": "UserProfile"
- },
- "lastAccessTime": {
- "type": "string",
- "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly",
- "format": "google-datetime"
- },
- "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": "User"
- },
- "ListAnalyticsResponse": {
- "description": "Response message for\nListAnalytics.",
- "type": "object",
- "properties": {
- "analytics": {
- "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
- "type": "array",
- "items": {
- "$ref": "Analytics"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.",
- "type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "analyticsSummary": {
- "description": "Aggregated information across the response's\nanalytics.",
- "$ref": "AnalyticsSummary"
- }
- },
- "id": "ListAnalyticsResponse"
- },
- "Company": {
- "type": "object",
- "properties": {
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Basic information from the company's public profile."
- },
- "services": {
- "enumDescriptions": [
- "Unchosen.",
- "Help with advanced AdWords support.",
- "Help with advertising on Google.",
- "Help with an enhanced website.",
- "Help with an online marketing plan.",
- "Help with mobile and video ads.",
- "Help with mobile websites."
- ],
- "description": "Services the company can help with.",
- "type": "array",
- "items": {
- "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"
- ]
- }
- },
- "primaryLocation": {
- "$ref": "Location",
- "description": "The primary location of the company."
- },
- "originalMinMonthlyBudget": {
- "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness.",
- "$ref": "Money"
- },
- "ranks": {
- "type": "array",
- "items": {
- "$ref": "Rank"
- },
- "description": "Information related to the ranking of the company within the list of\ncompanies."
- },
- "specializationStatus": {
- "description": "The list of Google Partners specialization statuses for the company.",
- "type": "array",
- "items": {
- "$ref": "SpecializationStatus"
- }
- },
- "badgeTier": {
- "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"
- ],
- "description": "Partner badge tier"
- },
- "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"
- }
- },
- "companyTypes": {
- "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"
- ]
- },
- "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."
- ]
- },
- "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": {
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Company profile does not show up publicly.",
- "Company profile can only be viewed by the profile's URL\nand not by Google Partner Search.",
- "Company profile can be viewed by the profile's URL\nand by Google Partner Search."
- ],
- "enum": [
- "COMPANY_PROFILE_STATUS_UNSPECIFIED",
- "HIDDEN",
- "PUBLISHED",
- "SEARCHABLE"
- ],
- "description": "The public viewability status of the company's profile."
- },
- "locations": {
- "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
- "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"
- },
- "industries": {
- "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"
- },
- "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."
- ]
- },
- "websiteUrl": {
- "description": "URL of the company's website.",
- "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"
- }
- },
- "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"
- }
- },
- "certificationStatuses": {
- "description": "The list of Google Partners certification statuses for the company.",
- "type": "array",
- "items": {
- "$ref": "CertificationStatus"
- }
- },
- "id": {
- "description": "The ID of the company.",
- "type": "string"
- }
- },
- "id": "Company",
- "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers."
- },
- "ListLeadsResponse": {
- "description": "Response message for ListLeads.",
- "type": "object",
- "properties": {
- "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"
- },
- "leads": {
- "description": "The list of leads.",
- "type": "array",
- "items": {
- "$ref": "Lead"
- }
- }
- },
- "id": "ListLeadsResponse"
- },
- "CreateLeadResponse": {
- "description": "Response message for CreateLead.",
- "type": "object",
- "properties": {
- "lead": {
- "$ref": "Lead",
- "description": "Lead that was created depending on the outcome of\n\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e validation."
- },
- "recaptchaStatus": {
- "enumDescriptions": [
- "Unchosen.",
- "No reCaptcha validation needed.",
- "reCaptcha challenge passed.",
- "reCaptcha challenge failed."
- ],
- "enum": [
- "RECAPTCHA_STATUS_UNSPECIFIED",
- "RS_NOT_NEEDED",
- "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."
- },
- "regionCode": {
- "description": "CLDR (Common Locale Data Repository) region code .",
- "type": "string"
- },
- "dependentLocality": {
- "description": "Dependent locality or sublocality. Used for UK dependent localities, or\nneighborhoods or boroughs in other locations.",
- "type": "string"
- },
- "address": {
- "type": "string",
- "description": "The single string version of the address."
- },
- "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"
- },
- "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": {
- "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 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."
- ]
- }
- },
- "id": "CertificationExamStatus"
- },
- "ExamToken": {
- "type": "object",
- "properties": {
- "examId": {
- "description": "The id of the exam the token is for.",
- "format": "int64",
- "type": "string"
- },
- "token": {
- "description": "The token, only present if the user has access to the exam.",
- "type": "string"
- },
- "examType": {
- "description": "The type of the exam the token belongs to.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Adwords Fundamentals exam.",
- "AdWords advanced search exam.",
- "AdWords advanced display exam.",
- "VideoAds exam.",
- "DoubleClick exam.",
- "Analytics exam.",
- "Shopping exam.",
- "Mobile exam.",
- "Digital Sales exam.",
- "Mobile Sites exam."
- ],
- "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": "ExamToken",
- "description": "A token that allows a user to take an exam."
- },
- "OptIns": {
- "description": "A set of opt-ins for a user.",
- "type": "object",
- "properties": {
- "marketComm": {
- "description": "An opt-in about receiving email from Partners marketing teams. Includes\nmember-only events and special promotional offers for Google products.",
- "type": "boolean"
- },
- "specialOffers": {
- "description": "An opt-in about receiving email regarding new features and products.",
- "type": "boolean"
- },
- "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"
- }
- },
- "id": "OptIns"
- },
"Rank": {
- "description": "Information related to ranking of results.",
- "type": "object",
"properties": {
"type": {
- "enum": [
- "RANK_TYPE_UNSPECIFIED",
- "RT_FINAL_SCORE"
- ],
"description": "The type of rank.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
"Total final score."
+ ],
+ "enum": [
+ "RANK_TYPE_UNSPECIFIED",
+ "RT_FINAL_SCORE"
]
},
"value": {
@@ -2342,13 +1253,15 @@
"type": "number"
}
},
- "id": "Rank"
+ "id": "Rank",
+ "description": "Information related to ranking of results.",
+ "type": "object"
},
"GetPartnersStatusResponse": {
"properties": {
"responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
"id": "GetPartnersStatusResponse",
@@ -2360,10 +1273,47 @@
"description": "The profile information of a Partners user.",
"type": "object",
"properties": {
+ "channels": {
+ "description": "A list of ids representing which channels the user selected they were in.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "profilePublic": {
+ "description": "Whether the user's public profile is visible to anyone with the URL.",
+ "type": "boolean"
+ },
+ "jobFunctions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of ids represnting which job categories the user selected."
+ },
+ "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"
},
+ "emailOptIns": {
+ "description": "The list of opt-ins for the user, related to communication preferences.",
+ "$ref": "OptIns"
+ },
"languages": {
"description": "The list of languages this user understands.",
"type": "array",
@@ -2371,10 +1321,6 @@
"type": "string"
}
},
- "emailOptIns": {
- "$ref": "OptIns",
- "description": "The list of opt-ins for the user, related to communication preferences."
- },
"markets": {
"description": "A list of ids representing which markets the user was interested in.",
"type": "array",
@@ -2382,14 +1328,14 @@
"type": "string"
}
},
- "phoneNumber": {
- "description": "The user's phone number.",
- "type": "string"
- },
"adwordsManagerAccount": {
+ "type": "string",
"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"
+ "format": "int64"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "description": "The user's phone number."
},
"primaryCountryCode": {
"description": "The user's primary country, an ISO 2-character code.",
@@ -2398,39 +1344,6 @@
"emailAddress": {
"description": "The email address the user has selected on the Partners site as primary.",
"type": "string"
- },
- "profilePublic": {
- "description": "Whether the user's public profile is visible to anyone with the URL.",
- "type": "boolean"
- },
- "channels": {
- "description": "A list of ids representing which channels the user selected they were in.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "jobFunctions": {
- "description": "A list of ids represnting which job categories the user selected.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "givenName": {
- "description": "The user's given name.",
- "type": "string"
- },
- "address": {
- "description": "The user's mailing address, contains multiple fields.",
- "$ref": "Location"
- },
- "industries": {
- "description": "A list of ids representing which industries the user selected.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
}
},
@@ -2438,19 +1351,6 @@
"description": "Historical information about a Google Partners Offer.",
"type": "object",
"properties": {
- "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": {
- "type": "string",
- "description": "Time this offer expires.",
- "format": "google-datetime"
- },
"offerCode": {
"description": "Offer code.",
"type": "string"
@@ -2460,10 +1360,6 @@
"format": "google-datetime",
"type": "string"
},
- "clientEmail": {
- "description": "Email address for client.",
- "type": "string"
- },
"status": {
"enumDescriptions": [
"Unset.",
@@ -2482,6 +1378,10 @@
"description": "Status of the offer.",
"type": "string"
},
+ "clientEmail": {
+ "description": "Email address for client.",
+ "type": "string"
+ },
"clientId": {
"description": "ID of client.",
"format": "int64",
@@ -2515,77 +1415,32 @@
"OFFER_TYPE_SPEND_MATCH"
],
"description": "Type of offer."
+ },
+ "senderName": {
+ "description": "Name (First + Last) of the partners user to whom the incentive is allocated.",
+ "type": "string"
+ },
+ "offerCountryCode": {
+ "description": "Country Code for the offer country.",
+ "type": "string"
+ },
+ "expirationTime": {
+ "description": "Time this offer expires.",
+ "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": {
- "ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
- "userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- }
- },
- "id": "UserOverrides"
- },
"LogUserEventRequest": {
- "id": "LogUserEventRequest",
"description": "Request message for\nLogUserEvent.",
"type": "object",
"properties": {
- "eventCategory": {
- "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"
- ],
- "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."
- ]
- },
"lead": {
"$ref": "Lead",
"description": "Advertiser lead information."
},
"eventAction": {
- "description": "The action that occurred.",
- "type": "string",
"enumDescriptions": [
"Unchosen.",
"Advertiser clicked `Find a partner` bottom button.",
@@ -2901,7 +1756,9 @@
"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"
},
"url": {
"description": "The URL where the event occurred.",
@@ -2911,14 +1768,13 @@
"$ref": "RequestMetadata",
"description": "Current request metadata."
},
- "eventDatas": {
- "type": "array",
- "items": {
- "$ref": "EventData"
- },
- "description": "List of event data for the event."
- },
"eventScope": {
+ "enum": [
+ "EVENT_SCOPE_UNSPECIFIED",
+ "VISITOR",
+ "SESSION",
+ "PAGE"
+ ],
"description": "The scope of the event.",
"type": "string",
"enumDescriptions": [
@@ -2926,30 +1782,87 @@
"Based on visitor.",
"Based on session.",
"Based on page visit."
+ ]
+ },
+ "eventDatas": {
+ "description": "List of event data for the event.",
+ "type": "array",
+ "items": {
+ "$ref": "EventData"
+ }
+ },
+ "eventCategory": {
+ "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_SCOPE_UNSPECIFIED",
- "VISITOR",
- "SESSION",
- "PAGE"
- ]
+ "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"
+ ],
+ "description": "The category the action belongs to.",
+ "type": "string"
}
- }
+ },
+ "id": "LogUserEventRequest"
+ },
+ "UserOverrides": {
+ "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products.",
+ "type": "object",
+ "properties": {
+ "userId": {
+ "type": "string",
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ }
+ },
+ "id": "UserOverrides"
},
"AnalyticsDataPoint": {
"type": "object",
"properties": {
+ "eventCount": {
+ "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
+ "format": "int32",
+ "type": "integer"
+ },
"eventLocations": {
"description": "Location information of where these events occurred.",
"type": "array",
"items": {
"$ref": "LatLng"
}
- },
- "eventCount": {
- "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
- "format": "int32",
- "type": "integer"
}
},
"id": "AnalyticsDataPoint",
@@ -2978,8 +1891,23 @@
},
"id": "Analytics"
},
+ "AdWordsManagerAccountInfo": {
+ "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
+ "type": "object",
+ "properties": {
+ "customerName": {
+ "type": "string",
+ "description": "Name of the customer this account represents."
+ },
+ "id": {
+ "description": "The AdWords Manager Account id.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "AdWordsManagerAccountInfo"
+ },
"PublicProfile": {
- "id": "PublicProfile",
"description": "Basic information from a public profile.",
"type": "object",
"properties": {
@@ -3003,31 +1931,16 @@
"description": "The URL to the main display image of the public profile. Being deprecated.",
"type": "string"
}
- }
- },
- "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": {
- "type": "string",
- "description": "Name of the customer this account represents."
- }
},
- "id": "AdWordsManagerAccountInfo"
+ "id": "PublicProfile"
},
"ResponseMetadata": {
"description": "Common data that is in each API response.",
"type": "object",
"properties": {
"debugInfo": {
- "$ref": "DebugInfo",
- "description": "Debug information about this request."
+ "description": "Debug information about this request.",
+ "$ref": "DebugInfo"
}
},
"id": "ResponseMetadata"
@@ -3048,31 +1961,9 @@
"id": "RecaptchaChallenge"
},
"AvailableOffer": {
+ "description": "Available Offers to be distributed.",
+ "type": "object",
"properties": {
- "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",
@@ -3118,12 +2009,6 @@
}
},
"offerType": {
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
"description": "Type of offer.",
"type": "string",
"enumDescriptions": [
@@ -3131,31 +2016,59 @@
"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"
]
},
"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"
}
},
- "id": "AvailableOffer",
- "description": "Available Offers to be distributed.",
- "type": "object"
+ "id": "AvailableOffer"
},
"LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\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.",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
"type": "object",
"properties": {
- "longitude": {
- "type": "number",
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "format": "double"
- },
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double",
"type": "number"
+ },
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "format": "double",
+ "type": "number"
}
},
"id": "LatLng"
@@ -3204,27 +2117,7 @@
"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"
@@ -3239,118 +2132,78 @@
"requestMetadata": {
"$ref": "RequestMetadata",
"description": "Current request metadata."
+ },
+ "level": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Message level for tracing information.",
+ "Message level for informational messages.",
+ "Message level for potential problems.",
+ "Message level for serious failures."
+ ],
+ "enum": [
+ "MESSAGE_LEVEL_UNSPECIFIED",
+ "ML_FINE",
+ "ML_INFO",
+ "ML_WARNING",
+ "ML_SEVERE"
+ ],
+ "description": "Message level of client message.",
+ "type": "string"
}
},
- "id": "LogMessageRequest"
+ "id": "LogMessageRequest",
+ "description": "Request message for\nLogClientMessage.",
+ "type": "object"
},
"DebugInfo": {
- "id": "DebugInfo",
- "description": "Debug information about this request.",
"type": "object",
"properties": {
+ "serverInfo": {
+ "description": "Info about the server that serviced this request.",
+ "type": "string"
+ },
+ "serverTraceInfo": {
+ "description": "Server-side debug stack trace.",
+ "type": "string"
+ },
"serviceUrl": {
"description": "URL of the service that handled this request.",
"type": "string"
- },
- "serverInfo": {
- "type": "string",
- "description": "Info about the server that serviced this request."
- },
- "serverTraceInfo": {
- "type": "string",
- "description": "Server-side debug stack trace."
}
- }
+ },
+ "id": "DebugInfo",
+ "description": "Debug information about this request."
},
"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": {
- "givenName": {
- "type": "string",
- "description": "First name of lead source."
- },
- "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": {
- "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"
- ]
- },
- "enumDescriptions": [
- "Unchosen.",
- "Advertiser needs help with their advertising.",
- "Advertiser needs help with their website.",
- "Advertiser does not have a website."
- ]
- },
- "email": {
- "description": "Email address of lead source.",
- "type": "string"
- },
- "familyName": {
- "description": "Last name of lead source.",
- "type": "string"
- },
"comments": {
- "type": "string",
- "description": "Comments lead source gave."
+ "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"
},
+ "phoneNumber": {
+ "description": "Phone number of lead source.",
+ "type": "string"
+ },
"createTime": {
"description": "Timestamp of when this lead was created.",
"format": "google-datetime",
"type": "string"
},
"marketingOptIn": {
- "type": "boolean",
- "description": "Whether or not the lead signed up for marketing emails"
+ "description": "Whether or not the lead signed up for marketing emails",
+ "type": "boolean"
},
"type": {
"enum": [
@@ -3363,41 +2216,106 @@
"Unchosen.",
"Google Partner Search."
]
+ },
+ "givenName": {
+ "description": "First name of lead source.",
+ "type": "string"
+ },
+ "minMonthlyBudget": {
+ "$ref": "Money",
+ "description": "The minimum monthly budget lead source is willing to spend."
+ },
+ "websiteUrl": {
+ "type": "string",
+ "description": "Website URL of lead source."
+ },
+ "languageCode": {
+ "type": "string",
+ "description": "Language code of the lead's language preference, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\")."
+ },
+ "state": {
+ "enum": [
+ "LEAD_STATE_UNSPECIFIED",
+ "LEAD",
+ "CONTACTED",
+ "CLIENT",
+ "OTHER"
+ ],
+ "description": "The lead's state in relation to the company.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Lead not yet contacted.",
+ "Lead has been contacted.",
+ "Lead has become a client.",
+ "Lead in a state not covered by other options."
+ ]
+ },
+ "gpsMotivations": {
+ "type": "array",
+ "items": {
+ "enum": [
+ "GPS_MOTIVATION_UNSPECIFIED",
+ "GPSM_HELP_WITH_ADVERTISING",
+ "GPSM_HELP_WITH_WEBSITE",
+ "GPSM_NO_WEBSITE"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "Unchosen.",
+ "Advertiser needs help with their advertising.",
+ "Advertiser needs help with their website.",
+ "Advertiser does not have a website."
+ ],
+ "description": "List of reasons for using Google Partner Search and creating a lead."
+ },
+ "email": {
+ "description": "Email address of lead source.",
+ "type": "string"
+ },
+ "familyName": {
+ "description": "Last name of lead source.",
+ "type": "string"
}
},
- "id": "Lead",
- "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal)."
+ "id": "Lead"
},
"ListUserStatesResponse": {
+ "description": "Response message for\nListUserStates.",
+ "type": "object",
"properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
"userStates": {
"description": "User's states.",
"type": "array",
"items": {
- "type": "string",
"enum": [
"USER_STATE_UNSPECIFIED",
"US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT"
- ]
+ ],
+ "type": "string"
},
"enumDescriptions": [
"Unchosen.",
"User must pass \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e to\ncontact a Partner via Google Partner Search."
]
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
- "id": "ListUserStatesResponse",
- "description": "Response message for\nListUserStates.",
- "type": "object"
+ "id": "ListUserStatesResponse"
},
"CompanyRelation": {
"description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
"type": "object",
"properties": {
+ "resolvedTimestamp": {
+ "description": "The timestamp when the user was approved.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
"companyAdmin": {
"description": "Indicates if the user is an admin for this company.",
"type": "boolean"
@@ -3415,6 +2333,10 @@
"format": "google-datetime",
"type": "string"
},
+ "primaryAddress": {
+ "$ref": "Location",
+ "description": "The primary location of the company."
+ },
"state": {
"description": "The state of relationship, in terms of approvals.",
"type": "string",
@@ -3436,9 +2358,9 @@
"type": "string"
},
"managerAccount": {
- "type": "string",
"description": "The AdWords manager account # associated this company.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"segment": {
"enumDescriptions": [
@@ -3450,18 +2372,23 @@
"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"
- ],
- "type": "string"
+ ]
+ }
+ },
+ "specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "SpecializationStatus"
}
},
"badgeTier": {
- "description": "Whether the company is a Partner.",
- "type": "string",
"enumDescriptions": [
"Tier badge is not set.",
"Agency has regular partner badge.",
@@ -3471,42 +2398,38 @@
"BADGE_TIER_NONE",
"BADGE_TIER_REGULAR",
"BADGE_TIER_PREMIER"
- ]
- },
- "specializationStatus": {
- "description": "The list of Google Partners specialization statuses for the company.",
- "type": "array",
- "items": {
- "$ref": "SpecializationStatus"
- }
- },
- "phoneNumber": {
- "description": "The phone number for the company's primary address.",
+ ],
+ "description": "Whether the company is a Partner.",
"type": "string"
},
"website": {
"description": "The website URL for this company.",
"type": "string"
},
- "companyId": {
+ "phoneNumber": {
"type": "string",
- "description": "The ID of the company. There may be no id if this is a\npending company.5"
+ "description": "The phone number for the company's primary address."
+ },
+ "primaryCountryCode": {
+ "description": "The primary country code of the company.",
+ "type": "string"
+ },
+ "companyId": {
+ "description": "The ID of the company. There may be no id if this is a\npending company.5",
+ "type": "string"
+ },
+ "primaryLanguageCode": {
+ "description": "The primary language code of the company.",
+ "type": "string"
},
"logoUrl": {
"description": "A URL to a profile photo, e.g. a G+ profile photo.",
"type": "string"
- },
- "resolvedTimestamp": {
- "description": "The timestamp when the user was approved.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
}
},
"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.",
@@ -3524,7 +2447,9 @@
"type": "integer"
}
},
- "id": "Date"
+ "id": "Date",
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "type": "object"
},
"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 `{}`.",
@@ -3537,8 +2462,8 @@
"type": "object",
"properties": {
"trafficSourceId": {
- "type": "string",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ "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.",
@@ -3548,6 +2473,8 @@
"id": "TrafficSource"
},
"CreateLeadRequest": {
+ "description": "Request message for CreateLead.",
+ "type": "object",
"properties": {
"requestMetadata": {
"$ref": "RequestMetadata",
@@ -3558,13 +2485,11 @@
"$ref": "Lead"
},
"recaptchaChallenge": {
- "$ref": "RecaptchaChallenge",
- "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info."
+ "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.",
+ "$ref": "RecaptchaChallenge"
}
},
- "id": "CreateLeadRequest",
- "description": "Request message for CreateLead.",
- "type": "object"
+ "id": "CreateLeadRequest"
},
"RequestMetadata": {
"description": "Common data that is in each API request.",
@@ -3575,19 +2500,19 @@
"type": "string"
},
"userOverrides": {
- "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products.",
- "$ref": "UserOverrides"
+ "$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"
- },
- "description": "Experiment IDs the current request belongs to."
+ }
},
"trafficSource": {
"$ref": "TrafficSource",
@@ -3595,22 +2520,1109 @@
}
},
"id": "RequestMetadata"
+ },
+ "EventData": {
+ "description": "Key value data pair for an event.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "enum": [
+ "EVENT_DATA_TYPE_UNSPECIFIED",
+ "ACTION",
+ "AGENCY_ID",
+ "AGENCY_NAME",
+ "AGENCY_PHONE_NUMBER",
+ "AGENCY_WEBSITE",
+ "BUDGET",
+ "CENTER_POINT",
+ "CERTIFICATION",
+ "COMMENT",
+ "COUNTRY",
+ "CURRENCY",
+ "CURRENTLY_VIEWED_AGENCY_ID",
+ "DISTANCE",
+ "DISTANCE_TYPE",
+ "EXAM",
+ "HISTORY_TOKEN",
+ "ID",
+ "INDUSTRY",
+ "INSIGHT_TAG",
+ "LANGUAGE",
+ "LOCATION",
+ "MARKETING_OPT_IN",
+ "QUERY",
+ "SEARCH_START_INDEX",
+ "SERVICE",
+ "SHOW_VOW",
+ "SOLUTION",
+ "TRAFFIC_SOURCE_ID",
+ "TRAFFIC_SUB_ID",
+ "VIEW_PORT",
+ "WEBSITE",
+ "DETAILS",
+ "EXPERIMENT_ID",
+ "GPS_MOTIVATION",
+ "URL",
+ "ELEMENT_FOCUS",
+ "PROGRESS"
+ ],
+ "description": "Data type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Action data.",
+ "Agency ID data.",
+ "Agency name data.",
+ "Agency phone number data.",
+ "Agency website data.",
+ "Budget data.",
+ "Center-point data.",
+ "Certification data.",
+ "Comment data.",
+ "Country data.",
+ "Currency data.",
+ "Currently viewed agency ID data.",
+ "Distance data.",
+ "Distance type data.",
+ "Exam data.",
+ "History token data.",
+ "Identifier data.",
+ "Industry data.",
+ "Insight tag data.",
+ "Language data.",
+ "Location data.",
+ "Marketing opt-in data.",
+ "Query data.",
+ "Search start index data.",
+ "Service data.",
+ "Show vow data.",
+ "Solution data.",
+ "Traffic source ID data.",
+ "Traffic sub ID data.",
+ "Viewport data.",
+ "Website data.",
+ "Details data.",
+ "Experiment ID data.",
+ "Google Partner Search motivation data.",
+ "URL data.",
+ "Element we wanted user to focus on.",
+ "Progress when viewing an item \\[0-100\\]."
+ ]
+ },
+ "values": {
+ "description": "Data values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "EventData"
+ },
+ "ExamStatus": {
+ "description": "A user's information on a specific exam.",
+ "type": "object",
+ "properties": {
+ "taken": {
+ "description": "The date the user last taken this exam.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "passed": {
+ "description": "Whether this exam has been passed and not expired.",
+ "type": "boolean"
+ },
+ "warning": {
+ "description": "Whether this exam is in the state of warning.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Date this exam is due to expire.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "lastPassed": {
+ "type": "string",
+ "description": "The date the user last passed this exam.",
+ "format": "google-datetime"
+ },
+ "examType": {
+ "description": "The type of the exam.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Adwords Fundamentals exam.",
+ "AdWords advanced search exam.",
+ "AdWords advanced display exam.",
+ "VideoAds exam.",
+ "DoubleClick exam.",
+ "Analytics exam.",
+ "Shopping exam.",
+ "Mobile exam.",
+ "Digital Sales exam.",
+ "Mobile Sites exam."
+ ],
+ "enum": [
+ "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
+ "CET_ADWORDS_FUNDAMENTALS",
+ "CET_ADWORDS_ADVANCED_SEARCH",
+ "CET_ADWORDS_ADVANCED_DISPLAY",
+ "CET_VIDEO_ADS",
+ "CET_DOUBLECLICK",
+ "CET_ANALYTICS",
+ "CET_SHOPPING",
+ "CET_MOBILE",
+ "CET_DIGITAL_SALES",
+ "CET_MOBILE_SITES"
+ ]
+ }
+ },
+ "id": "ExamStatus"
+ },
+ "ListOffersResponse": {
+ "description": "Response for ListOffer.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ }
+ },
+ "id": "ListOffersResponse"
+ },
+ "CountryOfferInfo": {
+ "description": "Offer info by country.",
+ "type": "object",
+ "properties": {
+ "getYAmount": {
+ "description": "(localized) Get Y amount for that country's offer.",
+ "type": "string"
+ },
+ "offerCountryCode": {
+ "description": "Country code for which offer codes may be requested.",
+ "type": "string"
+ },
+ "spendXAmount": {
+ "description": "(localized) Spend X amount for that country's offer.",
+ "type": "string"
+ },
+ "offerType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "description": "Type of offer country is eligible for."
+ }
+ },
+ "id": "CountryOfferInfo"
+ },
+ "ListCompaniesResponse": {
+ "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",
+ "description": "Response message for\nListCompanies."
+ },
+ "OfferCustomer": {
+ "description": "Customers qualified for an offer.",
+ "type": "object",
+ "properties": {
+ "getYAmount": {
+ "description": "Formatted Get Y amount with currency code.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the customer."
+ },
+ "spendXAmount": {
+ "description": "Formatted Spend X amount with currency code.",
+ "type": "string"
+ },
+ "adwordsUrl": {
+ "description": "URL to the customer's AdWords page.",
+ "type": "string"
+ },
+ "countryCode": {
+ "type": "string",
+ "description": "Country code of the customer."
+ },
+ "creationTime": {
+ "description": "Time the customer was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "eligibilityDaysLeft": {
+ "type": "integer",
+ "description": "Days the customer is still eligible.",
+ "format": "int32"
+ },
+ "offerType": {
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "description": "Type of the offer",
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ]
+ },
+ "externalCid": {
+ "description": "External CID for the customer.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "OfferCustomer"
+ },
+ "CertificationStatus": {
+ "properties": {
+ "examStatuses": {
+ "description": "List of certification exam statuses.",
+ "type": "array",
+ "items": {
+ "$ref": "CertificationExamStatus"
+ }
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "AdWords certified.",
+ "YouTube certified.",
+ "VideoAds certified.",
+ "Analytics certified.",
+ "DoubleClick certified.",
+ "Shopping certified.",
+ "Mobile certified.",
+ "Digital sales certified.",
+ "AdWords Search certified.",
+ "AdWords Display certified.",
+ "Mobile Sites certified."
+ ],
+ "enum": [
+ "CERTIFICATION_TYPE_UNSPECIFIED",
+ "CT_ADWORDS",
+ "CT_YOUTUBE",
+ "CT_VIDEOADS",
+ "CT_ANALYTICS",
+ "CT_DOUBLECLICK",
+ "CT_SHOPPING",
+ "CT_MOBILE",
+ "CT_DIGITAL_SALES",
+ "CT_ADWORDS_SEARCH",
+ "CT_ADWORDS_DISPLAY",
+ "CT_MOBILE_SITES"
+ ],
+ "description": "The type of the certification.",
+ "type": "string"
+ },
+ "userCount": {
+ "description": "Number of people who are certified,",
+ "format": "int32",
+ "type": "integer"
+ },
+ "isCertified": {
+ "description": "Whether certification is passing.",
+ "type": "boolean"
+ }
+ },
+ "id": "CertificationStatus",
+ "description": "Google Partners certification status.",
+ "type": "object"
+ },
+ "LocalizedCompanyInfo": {
+ "description": "The localized company information.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "Localized display name.",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Language code of the localized company info, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "LocalizedCompanyInfo"
+ },
+ "LogUserEventResponse": {
+ "description": "Response message for\nLogUserEvent.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "LogUserEventResponse"
+ },
+ "ListOffersHistoryResponse": {
+ "description": "Response for ListOfferHistory.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
+ "type": "string"
+ },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ },
+ "canShowEntireCompany": {
+ "description": "True if the user has the option to show entire company history.",
+ "type": "boolean"
+ },
+ "totalResults": {
+ "description": "Number of results across all pages.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "showingEntireCompany": {
+ "type": "boolean",
+ "description": "True if this response is showing entire company history."
+ },
+ "offers": {
+ "type": "array",
+ "items": {
+ "$ref": "HistoricalOffer"
+ },
+ "description": "Historical offers meeting request."
+ }
+ },
+ "id": "ListOffersHistoryResponse"
+ },
+ "LogMessageResponse": {
+ "id": "LogMessageResponse",
+ "description": "Response message for\nLogClientMessage.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ }
+ },
+ "SpecializationStatus": {
+ "description": "Agency specialization status",
+ "type": "object",
+ "properties": {
+ "badgeSpecialization": {
+ "description": "The specialization this status is for.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown specialization",
+ "AdWords Search specialization",
+ "AdWords Display specialization",
+ "AdWords Mobile specialization",
+ "AdWords Video specialization",
+ "AdWords Shopping specialization"
+ ],
+ "enum": [
+ "BADGE_SPECIALIZATION_UNKNOWN",
+ "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
+ "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
+ "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
+ "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
+ "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
+ ]
+ },
+ "badgeSpecializationState": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown state",
+ "Specialization passed",
+ "Specialization not passed",
+ "Specialization in grace"
+ ],
+ "enum": [
+ "BADGE_SPECIALIZATION_STATE_UNKNOWN",
+ "BADGE_SPECIALIZATION_STATE_PASSED",
+ "BADGE_SPECIALIZATION_STATE_NOT_PASSED",
+ "BADGE_SPECIALIZATION_STATE_IN_GRACE"
+ ],
+ "description": "State of agency specialization."
+ }
+ },
+ "id": "SpecializationStatus"
+ },
+ "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",
+ "description": "A user's information on a specific 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": {
+ "$ref": "CompanyRelation",
+ "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company."
+ },
+ "lastAccessTime": {
+ "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "availableAdwordsManagerAccounts": {
+ "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "AdWordsManagerAccountInfo"
+ }
+ },
+ "primaryEmails": {
+ "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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": {
+ "type": "string",
+ "description": "The email address used by the user used for company verification.\n@OutputOnly"
+ },
+ "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": {
+ "properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
+ "analyticsSummary": {
+ "$ref": "AnalyticsSummary",
+ "description": "Aggregated information across the response's\nanalytics."
+ },
+ "analytics": {
+ "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
+ "type": "array",
+ "items": {
+ "$ref": "Analytics"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListAnalyticsResponse",
+ "description": "Response message for\nListAnalytics.",
+ "type": "object"
+ },
+ "ListLeadsResponse": {
+ "description": "Response message for ListLeads.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "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."
+ },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ },
+ "totalSize": {
+ "description": "The total count of leads for the given company.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "leads": {
+ "description": "The list of leads.",
+ "type": "array",
+ "items": {
+ "$ref": "Lead"
+ }
+ }
+ },
+ "id": "ListLeadsResponse"
+ },
+ "Company": {
+ "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
+ "type": "object",
+ "properties": {
+ "localizedInfos": {
+ "description": "The list of localized info for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "LocalizedCompanyInfo"
+ }
+ },
+ "certificationStatuses": {
+ "description": "The list of Google Partners certification statuses for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "CertificationStatus"
+ }
+ },
+ "id": {
+ "description": "The ID of the company.",
+ "type": "string"
+ },
+ "primaryLocation": {
+ "description": "The primary location of the company.",
+ "$ref": "Location"
+ },
+ "originalMinMonthlyBudget": {
+ "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness.",
+ "$ref": "Money"
+ },
+ "publicProfile": {
+ "$ref": "PublicProfile",
+ "description": "Basic information from the company's public profile."
+ },
+ "services": {
+ "description": "Services the company can help with.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "SERVICE_UNSPECIFIED",
+ "S_ADVANCED_ADWORDS_SUPPORT",
+ "S_ADVERTISING_ON_GOOGLE",
+ "S_AN_ENHANCED_WEBSITE",
+ "S_AN_ONLINE_MARKETING_PLAN",
+ "S_MOBILE_AND_VIDEO_ADS",
+ "S_MOBILE_WEBSITE_SERVICES"
+ ],
+ "type": "string"
+ },
+ "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."
+ ]
+ },
+ "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": {
+ "enum": [
+ "BADGE_TIER_NONE",
+ "BADGE_TIER_REGULAR",
+ "BADGE_TIER_PREMIER"
+ ],
+ "description": "Partner badge tier",
+ "type": "string",
+ "enumDescriptions": [
+ "Tier badge is not set.",
+ "Agency has regular partner badge.",
+ "Agency has premier badge."
+ ]
+ },
+ "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": {
+ "enum": [
+ "COMPANY_TYPE_UNSPECIFIED",
+ "FULL_SERVICE_AGENCY",
+ "MEDIA_AGENCY",
+ "CREATIVE_AGENCY",
+ "CDIGITAL_AGENCY",
+ "SEM_SEO",
+ "PERFORMANCE_MARKETING",
+ "ADVERTISING_TOOL_DEVELOPMENT",
+ "PR",
+ "SELF_MANAGED",
+ "RESELLER"
+ ],
+ "type": "string"
+ }
+ },
+ "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": {
+ "$ref": "Money",
+ "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code."
+ },
+ "industries": {
+ "description": "Industries the company can help with.",
+ "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"
+ },
+ "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."
+ ]
+ },
+ "websiteUrl": {
+ "description": "URL of the company's website.",
+ "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"
+ }
+ },
+ "primaryAdwordsManagerAccountId": {
+ "description": "The Primary AdWords Manager Account id.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the company.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "properties": {
+ "company": {
+ "$ref": "Company",
+ "description": "The company."
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "GetCompanyResponse",
+ "description": "Response message for GetCompany.",
+ "type": "object"
+ },
+ "Location": {
+ "properties": {
+ "administrativeArea": {
+ "description": "Top-level administrative subdivision of this country.",
+ "type": "string"
+ },
+ "locality": {
+ "description": "Generally refers to the city/town portion of an address.",
+ "type": "string"
+ },
+ "latLng": {
+ "$ref": "LatLng",
+ "description": "The latitude and longitude of the location, in degrees."
+ },
+ "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": {
+ "type": "string",
+ "description": "CLDR (Common Locale Data Repository) region code ."
+ },
+ "postalCode": {
+ "description": "Values are frequently alphanumeric.",
+ "type": "string"
+ },
+ "sortingCode": {
+ "type": "string",
+ "description": "Use of this code is very country-specific, but will refer to a secondary\nclassification code for sorting mail."
+ },
+ "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",
+ "description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
+ "type": "object"
+ },
+ "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": {
+ "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 certification exam.",
+ "type": "string"
+ }
+ },
+ "id": "CertificationExamStatus"
+ },
+ "ExamToken": {
+ "description": "A token that allows a user to take an exam.",
+ "type": "object",
+ "properties": {
+ "examId": {
+ "description": "The id of the exam the token is for.",
+ "format": "int64",
+ "type": "string"
+ },
+ "token": {
+ "description": "The token, only present if the user has access to the exam.",
+ "type": "string"
+ },
+ "examType": {
+ "description": "The type of the exam the token belongs to.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Adwords Fundamentals exam.",
+ "AdWords advanced search exam.",
+ "AdWords advanced display exam.",
+ "VideoAds exam.",
+ "DoubleClick exam.",
+ "Analytics exam.",
+ "Shopping exam.",
+ "Mobile exam.",
+ "Digital Sales exam.",
+ "Mobile Sites exam."
+ ],
+ "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": "ExamToken"
+ },
+ "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": {
+ "type": "boolean",
+ "description": "An opt-in to receive special promotional gifts and material in the mail."
+ },
+ "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"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"version": "v2",
"baseUrl": "https://partners.googleapis.com/",
"canonicalName": "Partners",
"kind": "discovery#restDescription",
- "servicePath": "",
"description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.",
+ "servicePath": "",
"rootUrl": "https://partners.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "partners",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "revision": "20170530",
+ "id": "partners:v2",
+ "documentationLink": "https://developers.google.com/partners/",
+ "title": "Google Partners API"
}
diff --git a/partners/v2/partners-gen.go b/partners/v2/partners-gen.go
index 0502b0b..e015005 100644
--- a/partners/v2/partners-gen.go
+++ b/partners/v2/partners-gen.go
@@ -816,6 +816,15 @@
// PhoneNumber: The phone number for the company's primary address.
PhoneNumber string `json:"phoneNumber,omitempty"`
+ // PrimaryAddress: The primary location of the company.
+ PrimaryAddress *Location `json:"primaryAddress,omitempty"`
+
+ // PrimaryCountryCode: The primary country code of the company.
+ PrimaryCountryCode string `json:"primaryCountryCode,omitempty"`
+
+ // PrimaryLanguageCode: The primary language code of the company.
+ PrimaryLanguageCode string `json:"primaryLanguageCode,omitempty"`
+
// ResolvedTimestamp: The timestamp when the user was
// approved.
// @OutputOnly
@@ -1478,10 +1487,6 @@
// 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].
diff --git a/people/v1/people-api.json b/people/v1/people-api.json
index 06d4845..41e7fc7 100644
--- a/people/v1/people-api.json
+++ b/people/v1/people-api.json
@@ -1,34 +1,390 @@
{
"basePath": "",
- "revision": "20170508",
"documentationLink": "https://developers.google.com/people/",
"id": "people:v1",
+ "revision": "20170603",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "Photo": {
- "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
+ "PersonResponse": {
+ "description": "The response for a single person",
"type": "object",
"properties": {
- "url": {
- "description": "The URL of the photo.",
+ "httpStatusCode": {
+ "format": "int32",
+ "description": "DEPRECATED(Please use status instead).\n[HTTP 1.1 status\ncode](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
+ "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": {
+ "description": "The person.",
+ "$ref": "Person"
+ },
+ "status": {
+ "$ref": "Status",
+ "description": "The status of the response."
+ }
+ },
+ "id": "PersonResponse"
+ },
+ "RelationshipInterest": {
+ "description": "A person's read-only relationship interest .",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The kind of relationship the person is looking for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`",
+ "type": "string"
+ },
+ "formattedValue": {
+ "type": "string",
+ "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."
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relationship interest."
+ }
+ },
+ "id": "RelationshipInterest"
+ },
+ "Source": {
+ "description": "The source of a field.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "[Google Account](https://accounts.google.com).",
+ "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/\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": {
+ "description": "Metadata about a source of type PROFILE.",
+ "$ref": "ProfileMetadata"
+ }
+ },
+ "id": "Source"
+ },
+ "Relation": {
+ "id": "Relation",
+ "description": "A person's relation to another person.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "person": {
+ "description": "The name of the other person this relation refers to.",
+ "type": "string"
+ },
+ "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"
},
"metadata": {
- "description": "Metadata about the photo.",
+ "description": "Metadata about the relation.",
"$ref": "FieldMetadata"
}
+ }
+ },
+ "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": "Photo"
+ "id": "Occupation"
+ },
+ "Person": {
+ "id": "Person",
+ "description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data.\n\nMost fields can have multiple items. The items in a field have no guaranteed\norder, but each non-empty field is guaranteed to have exactly one field with\n`metadata.primary` set to true.",
+ "type": "object",
+ "properties": {
+ "addresses": {
+ "description": "The person's street addresses.",
+ "items": {
+ "$ref": "Address"
+ },
+ "type": "array"
+ },
+ "events": {
+ "description": "The person's events.",
+ "items": {
+ "$ref": "Event"
+ },
+ "type": "array"
+ },
+ "memberships": {
+ "description": "The person's group memberships.",
+ "items": {
+ "$ref": "Membership"
+ },
+ "type": "array"
+ },
+ "phoneNumbers": {
+ "items": {
+ "$ref": "PhoneNumber"
+ },
+ "type": "array",
+ "description": "The person's phone numbers."
+ },
+ "coverPhotos": {
+ "items": {
+ "$ref": "CoverPhoto"
+ },
+ "type": "array",
+ "description": "The person's cover photos."
+ },
+ "imClients": {
+ "items": {
+ "$ref": "ImClient"
+ },
+ "type": "array",
+ "description": "The person's instant messaging clients."
+ },
+ "birthdays": {
+ "description": "The person's birthdays.",
+ "items": {
+ "$ref": "Birthday"
+ },
+ "type": "array"
+ },
+ "locales": {
+ "description": "The person's locale preferences.",
+ "items": {
+ "$ref": "Locale"
+ },
+ "type": "array"
+ },
+ "relationshipInterests": {
+ "description": "The kind of relationship the person is looking for.",
+ "items": {
+ "$ref": "RelationshipInterest"
+ },
+ "type": "array"
+ },
+ "urls": {
+ "description": "The person's associated URLs.",
+ "items": {
+ "$ref": "Url"
+ },
+ "type": "array"
+ },
+ "nicknames": {
+ "description": "The person's nicknames.",
+ "items": {
+ "$ref": "Nickname"
+ },
+ "type": "array"
+ },
+ "relations": {
+ "description": "The person's relations.",
+ "items": {
+ "$ref": "Relation"
+ },
+ "type": "array"
+ },
+ "names": {
+ "description": "The person's names.",
+ "items": {
+ "$ref": "Name"
+ },
+ "type": "array"
+ },
+ "occupations": {
+ "description": "The person's occupations.",
+ "items": {
+ "$ref": "Occupation"
+ },
+ "type": "array"
+ },
+ "emailAddresses": {
+ "items": {
+ "$ref": "EmailAddress"
+ },
+ "type": "array",
+ "description": "The person's email addresses."
+ },
+ "organizations": {
+ "description": "The person's past or current organizations.",
+ "items": {
+ "$ref": "Organization"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "type": "string",
+ "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation."
+ },
+ "braggingRights": {
+ "description": "The person's bragging rights.",
+ "items": {
+ "$ref": "BraggingRights"
+ },
+ "type": "array"
+ },
+ "metadata": {
+ "description": "Metadata about the person.",
+ "$ref": "PersonMetadata"
+ },
+ "residences": {
+ "items": {
+ "$ref": "Residence"
+ },
+ "type": "array",
+ "description": "The person's residences."
+ },
+ "genders": {
+ "description": "The person's genders.",
+ "items": {
+ "$ref": "Gender"
+ },
+ "type": "array"
+ },
+ "interests": {
+ "description": "The person's interests.",
+ "items": {
+ "$ref": "Interest"
+ },
+ "type": "array"
+ },
+ "resourceName": {
+ "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of `people/\u003cperson_id\u003e`.",
+ "type": "string"
+ },
+ "biographies": {
+ "description": "The person's biographies.",
+ "items": {
+ "$ref": "Biography"
+ },
+ "type": "array"
+ },
+ "skills": {
+ "description": "The person's skills.",
+ "items": {
+ "$ref": "Skill"
+ },
+ "type": "array"
+ },
+ "relationshipStatuses": {
+ "description": "The person's relationship statuses.",
+ "items": {
+ "$ref": "RelationshipStatus"
+ },
+ "type": "array"
+ },
+ "photos": {
+ "description": "The person's photos.",
+ "items": {
+ "$ref": "Photo"
+ },
+ "type": "array"
+ },
+ "ageRange": {
+ "description": "DEPRECATED(Please read person.age_ranges instead). The person's age range.",
+ "type": "string",
+ "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"
+ ]
+ },
+ "taglines": {
+ "description": "The person's taglines.",
+ "items": {
+ "$ref": "Tagline"
+ },
+ "type": "array"
+ },
+ "ageRanges": {
+ "description": "The person's age ranges.",
+ "items": {
+ "$ref": "AgeRangeType"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "GetPeopleResponse": {
+ "type": "object",
+ "properties": {
+ "responses": {
+ "description": "The response for each requested resource name.",
+ "items": {
+ "$ref": "PersonResponse"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GetPeopleResponse"
+ },
+ "Photo": {
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the photo."
+ },
+ "url": {
+ "description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=\u003csize\u003e` at the end of the url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`",
+ "type": "string"
+ }
+ },
+ "id": "Photo",
+ "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person."
},
"PhoneNumber": {
"description": "A person's phone number.",
"type": "object",
"properties": {
- "value": {
- "description": "The phone number.",
+ "type": {
+ "description": "The type of the phone number. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFax`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `other`",
"type": "string"
},
+ "metadata": {
+ "description": "Metadata about the phone number.",
+ "$ref": "FieldMetadata"
+ },
+ "value": {
+ "type": "string",
+ "description": "The phone number."
+ },
"formattedType": {
"description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the the `Accept-Language` HTTP header locale.",
"type": "string"
@@ -36,72 +392,80 @@
"canonicalForm": {
"description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
"type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the phone number."
- },
- "type": {
- "description": "The type of the phone number. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFax`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `other`",
- "type": "string"
}
},
"id": "PhoneNumber"
},
"ListConnectionsResponse": {
+ "id": "ListConnectionsResponse",
"type": "object",
"properties": {
"nextPageToken": {
"description": "The token that can be used to retrieve the next page of results.",
"type": "string"
},
- "connections": {
- "description": "The list of people that the requestor is connected to.",
- "type": "array",
- "items": {
- "$ref": "Person"
- }
+ "totalItems": {
+ "format": "int32",
+ "description": "The total number of items in the list without pagination.",
+ "type": "integer"
},
"nextSyncToken": {
"description": "The token that can be used to retrieve changes since the last request.",
"type": "string"
},
- "totalItems": {
- "description": "The total number of items in the list without pagination.",
- "format": "int32",
- "type": "integer"
+ "connections": {
+ "description": "The list of people that the requestor is connected to.",
+ "items": {
+ "$ref": "Person"
+ },
+ "type": "array"
},
"totalPeople": {
- "description": "DEPRECATED(Please use total_items). The total number of people in the list\nwithout pagination.",
"format": "int32",
+ "description": "DEPRECATED(Please use total_items). The total number of people in the list\nwithout pagination.",
"type": "integer"
}
- },
- "id": "ListConnectionsResponse"
+ }
},
"Birthday": {
- "id": "Birthday",
- "description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to.",
"type": "object",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the birthday."
- },
"text": {
"description": "A free-form string representing the user's birthday.",
"type": "string"
},
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the birthday."
+ },
"date": {
"$ref": "Date",
"description": "The date of the birthday."
}
- }
+ },
+ "id": "Birthday",
+ "description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to."
},
"Address": {
"description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
"type": "object",
"properties": {
+ "formattedType": {
+ "type": "string",
+ "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale."
+ },
+ "city": {
+ "description": "The city of the address.",
+ "type": "string"
+ },
+ "formattedValue": {
+ "description": "The unstructured value of the address. If this is not set by the user it\nwill be automatically constructed from structured values.",
+ "type": "string"
+ },
+ "country": {
+ "type": "string",
+ "description": "The country of the address."
+ },
"type": {
"description": "The type of the address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
"type": "string"
@@ -115,16 +479,16 @@
"type": "string"
},
"postalCode": {
- "description": "The postal code of the address.",
- "type": "string"
+ "type": "string",
+ "description": "The postal code of the address."
},
"region": {
"description": "The region of the address; for example, the state or province.",
"type": "string"
},
"streetAddress": {
- "description": "The street address.",
- "type": "string"
+ "type": "string",
+ "description": "The street address."
},
"metadata": {
"$ref": "FieldMetadata",
@@ -133,22 +497,6 @@
"countryCode": {
"description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
"type": "string"
- },
- "formattedType": {
- "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "city": {
- "type": "string",
- "description": "The city of the address."
- },
- "formattedValue": {
- "description": "The unstructured value of the address. If this is not set by the user it\nwill be automatically constructed from structured values.",
- "type": "string"
- },
- "country": {
- "description": "The country of the address.",
- "type": "string"
}
},
"id": "Address"
@@ -157,17 +505,17 @@
"description": "A person's past or current residence.",
"type": "object",
"properties": {
- "value": {
- "description": "The address of the residence.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the residence.",
- "$ref": "FieldMetadata"
- },
"current": {
"description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
"type": "boolean"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the residence."
+ },
+ "value": {
+ "type": "string",
+ "description": "The address of the residence."
}
},
"id": "Residence"
@@ -176,25 +524,25 @@
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
- "description": "A list of messages that carry the error details. There 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"
- }
+ },
+ "type": "array",
+ "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use."
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
"id": "Status"
@@ -216,28 +564,28 @@
"properties": {
"linkedPeopleResourceNames": {
"description": "Resource names of people linked to this resource.",
- "type": "array",
"items": {
"type": "string"
- }
- },
- "sources": {
- "description": "The sources of data for the person.",
- "type": "array",
- "items": {
- "$ref": "Source"
- }
+ },
+ "type": "array"
},
"previousResourceNames": {
"description": "Any former resource names this person has had. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.\n\nThe resource name may change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
- "type": "array",
"items": {
"type": "string"
- }
+ },
+ "type": "array"
+ },
+ "sources": {
+ "description": "The sources of data for the person.",
+ "items": {
+ "$ref": "Source"
+ },
+ "type": "array"
},
"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"
+ "type": "boolean",
+ "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."
},
"objectType": {
"description": "DEPRECATED(Please read person.metadata.sources.profile_metadata instead).\nThe type of the person object.",
@@ -257,27 +605,27 @@
"id": "PersonMetadata"
},
"Event": {
+ "description": "An event related to the person.",
"type": "object",
"properties": {
- "metadata": {
- "description": "Metadata about the event.",
- "$ref": "FieldMetadata"
- },
- "type": {
- "description": "The type of the event. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `anniversary`\n* `other`",
- "type": "string"
- },
- "date": {
- "$ref": "Date",
- "description": "The date of the event."
- },
"formattedType": {
"description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the event. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `anniversary`\n* `other`"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the event."
+ },
+ "date": {
+ "description": "The date of the event.",
+ "$ref": "Date"
}
},
- "id": "Event",
- "description": "An event related to the person."
+ "id": "Event"
},
"ProfileMetadata": {
"description": "The read-only metadata about a profile.",
@@ -300,36 +648,13 @@
},
"id": "ProfileMetadata"
},
- "Url": {
- "description": "A person's associated URLs.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The URL.",
- "type": "string"
- },
- "formattedType": {
- "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the URL.",
- "$ref": "FieldMetadata"
- },
- "type": {
- "description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservations`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
- "type": "string"
- }
- },
- "id": "Url"
- },
"Gender": {
"description": "A person's gender.",
"type": "object",
"properties": {
"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"
+ "type": "string",
+ "description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale."
},
"metadata": {
"$ref": "FieldMetadata",
@@ -342,84 +667,143 @@
},
"id": "Gender"
},
- "CoverPhoto": {
+ "Url": {
+ "description": "A person's associated URLs.",
"type": "object",
"properties": {
+ "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"
+ },
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the cover photo."
+ "description": "Metadata about the URL."
},
+ "value": {
+ "description": "The URL.",
+ "type": "string"
+ },
+ "formattedType": {
+ "type": "string",
+ "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale."
+ }
+ },
+ "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": {
"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"
},
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the cover photo."
+ },
"url": {
"description": "The URL of the cover photo.",
"type": "string"
}
},
- "id": "CoverPhoto",
- "description": "A person's read-only cover photo. A large image shown on the person's\nprofile page that represents who they are or what they care about."
+ "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": {
- "id": "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": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the IM client."
+ },
+ "type": {
+ "description": "The type of the IM client. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
+ "type": "string"
+ },
"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"
}
- }
+ },
+ "id": "ImClient"
},
- "Interest": {
- "id": "Interest",
- "description": "One of the person's interests.",
+ "Nickname": {
+ "description": "A person's nickname.",
"type": "object",
"properties": {
- "value": {
- "description": "The interest; for example, `stargazing`.",
+ "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"
},
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the interest."
+ "description": "Metadata about the nickname.",
+ "$ref": "FieldMetadata"
+ },
+ "value": {
+ "description": "The nickname.",
+ "type": "string"
}
- }
+ },
+ "id": "Nickname"
},
"EmailAddress": {
+ "id": "EmailAddress",
+ "description": "A person's email address.",
+ "type": "object",
"properties": {
"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"
+ "type": "string",
+ "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`"
+ },
+ "metadata": {
+ "description": "Metadata about the email address.",
+ "$ref": "FieldMetadata"
},
"value": {
"description": "The email address.",
@@ -429,51 +813,15 @@
"description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
}
- },
- "id": "EmailAddress",
- "description": "A person's email address.",
- "type": "object"
- },
- "Nickname": {
- "description": "A person's nickname.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the nickname."
- },
- "type": {
- "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"
+ }
},
"Skill": {
"description": "A skill that the person has.",
"type": "object",
"properties": {
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the skill."
+ "description": "Metadata about the skill.",
+ "$ref": "FieldMetadata"
},
"value": {
"description": "The skill; for example, `underwater basket weaving`.",
@@ -483,6 +831,7 @@
"id": "Skill"
},
"DomainMembership": {
+ "description": "A Google Apps Domain membership.",
"type": "object",
"properties": {
"inViewerDomain": {
@@ -490,21 +839,20 @@
"type": "boolean"
}
},
- "id": "DomainMembership",
- "description": "A Google Apps Domain membership."
+ "id": "DomainMembership"
},
"Membership": {
"description": "A person's read-only membership in a group.",
"type": "object",
"properties": {
+ "domainMembership": {
+ "description": "The domain membership.",
+ "$ref": "DomainMembership"
+ },
"contactGroupMembership": {
"description": "The contact group membership.",
"$ref": "ContactGroupMembership"
},
- "domainMembership": {
- "$ref": "DomainMembership",
- "description": "The domain membership."
- },
"metadata": {
"description": "Metadata about the membership.",
"$ref": "FieldMetadata"
@@ -513,27 +861,47 @@
"id": "Membership"
},
"RelationshipStatus": {
- "description": "A person's read-only relationship status.",
"type": "object",
"properties": {
- "value": {
- "type": "string",
- "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`"
- },
"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"
+ "type": "string",
+ "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."
},
"metadata": {
- "description": "Metadata about the relationship status.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relationship status."
+ },
+ "value": {
+ "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
+ "type": "string"
}
},
- "id": "RelationshipStatus"
+ "id": "RelationshipStatus",
+ "description": "A person's read-only relationship status."
+ },
+ "Date": {
+ "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.",
+ "type": "object",
+ "properties": {
+ "month": {
+ "format": "int32",
+ "description": "Month of year. Must be from 1 to 12.",
+ "type": "integer"
+ },
+ "day": {
+ "format": "int32",
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "type": "integer"
+ },
+ "year": {
+ "format": "int32",
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "type": "integer"
+ }
+ },
+ "id": "Date"
},
"Tagline": {
- "description": "A read-only brief one-line description of the person.",
- "type": "object",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
@@ -544,32 +912,11 @@
"type": "string"
}
},
- "id": "Tagline"
- },
- "Date": {
- "properties": {
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32",
- "type": "integer"
- },
- "year": {
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "format": "int32",
- "type": "integer"
- },
- "day": {
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Date",
- "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.",
+ "id": "Tagline",
+ "description": "A read-only brief one-line description of the person.",
"type": "object"
},
"Name": {
- "id": "Name",
"description": "A person's name. If the name is a mononym, the family name is empty.",
"type": "object",
"properties": {
@@ -606,8 +953,8 @@
"type": "string"
},
"phoneticMiddleName": {
- "description": "The middle name(s) spelled as they sound.",
- "type": "string"
+ "type": "string",
+ "description": "The middle name(s) spelled as they sound."
},
"metadata": {
"description": "Metadata about the name.",
@@ -622,29 +969,30 @@
"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"
+ "type": "string",
+ "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."
},
"honorificSuffix": {
"description": "The honorific suffixes, such as `Jr.`",
"type": "string"
}
- }
+ },
+ "id": "Name"
},
"BraggingRights": {
+ "id": "BraggingRights",
+ "description": "A person's bragging rights.",
+ "type": "object",
"properties": {
"metadata": {
- "description": "Metadata about the bragging rights.",
- "$ref": "FieldMetadata"
+ "$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": {
"type": "object",
@@ -662,48 +1010,42 @@
"description": "A person's locale preference."
},
"Organization": {
- "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
- "type": "object",
"properties": {
- "endDate": {
- "description": "The end date when the person left the organization.",
- "$ref": "Date"
- },
"symbol": {
- "type": "string",
- "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym."
+ "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"
+ "type": "string",
+ "description": "The name of the organization."
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the organization."
},
- "location": {
- "description": "The location of the organization office the person works at.",
+ "title": {
+ "description": "The person's job title at the organization.",
"type": "string"
},
- "title": {
+ "location": {
"type": "string",
- "description": "The person's job title at the organization."
+ "description": "The location of the organization office the person works at."
},
"current": {
- "type": "boolean",
- "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization."
- },
- "startDate": {
- "description": "The start date when the person joined the organization.",
- "$ref": "Date"
+ "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
+ "type": "boolean"
},
"formattedType": {
"description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
+ "startDate": {
+ "$ref": "Date",
+ "description": "The start date when the person joined the organization."
+ },
"domain": {
- "type": "string",
- "description": "The domain name associated with the organization; for example, `google.com`."
+ "description": "The domain name associated with the organization; for example, `google.com`.",
+ "type": "string"
},
"department": {
"description": "The person's department at the organization.",
@@ -718,14 +1060,19 @@
"type": "string"
},
"jobDescription": {
- "description": "The person's job description at the organization.",
- "type": "string"
+ "type": "string",
+ "description": "The person's job description at the organization."
+ },
+ "endDate": {
+ "$ref": "Date",
+ "description": "The end date when the person left the organization."
}
},
- "id": "Organization"
+ "id": "Organization",
+ "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
+ "type": "object"
},
"Biography": {
- "description": "A person's short biography.",
"type": "object",
"properties": {
"value": {
@@ -733,30 +1080,35 @@
"type": "string"
},
"contentType": {
- "enumDescriptions": [
- "Unspecified.",
- "Plain text.",
- "HTML text."
- ],
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"TEXT_PLAIN",
"TEXT_HTML"
],
"description": "The content type of the biography.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Plain text.",
+ "HTML text."
+ ]
},
"metadata": {
"description": "Metadata about the biography.",
"$ref": "FieldMetadata"
}
},
- "id": "Biography"
+ "id": "Biography",
+ "description": "A person's short biography."
},
"AgeRangeType": {
"description": "A person's age range.",
"type": "object",
"properties": {
+ "metadata": {
+ "description": "Metadata about the age range.",
+ "$ref": "FieldMetadata"
+ },
"ageRange": {
"enumDescriptions": [
"Unspecified.",
@@ -772,15 +1124,12 @@
],
"description": "The age range.",
"type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the age range."
}
},
"id": "AgeRangeType"
},
"FieldMetadata": {
+ "id": "FieldMetadata",
"description": "Metadata about a field.",
"type": "object",
"properties": {
@@ -793,359 +1142,10 @@
"type": "boolean"
},
"primary": {
- "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "True if the field is the primary field; false if the field is a secondary\nfield."
}
- },
- "id": "FieldMetadata"
- },
- "Source": {
- "description": "The source of a field.",
- "type": "object",
- "properties": {
- "type": {
- "enum": [
- "SOURCE_TYPE_UNSPECIFIED",
- "ACCOUNT",
- "PROFILE",
- "DOMAIN_PROFILE",
- "CONTACT"
- ],
- "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."
- ]
- },
- "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": {
- "description": "Metadata about a source of type PROFILE.",
- "$ref": "ProfileMetadata"
- }
- },
- "id": "Source"
- },
- "RelationshipInterest": {
- "description": "A person's read-only relationship interest .",
- "type": "object",
- "properties": {
- "value": {
- "description": "The kind of relationship the person is looking for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`",
- "type": "string"
- },
- "formattedValue": {
- "description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the relationship interest.",
- "$ref": "FieldMetadata"
- }
- },
- "id": "RelationshipInterest"
- },
- "PersonResponse": {
- "description": "The response for a single person",
- "type": "object",
- "properties": {
- "person": {
- "description": "The person.",
- "$ref": "Person"
- },
- "status": {
- "$ref": "Status",
- "description": "The status of the response."
- },
- "httpStatusCode": {
- "description": "DEPRECATED(Please use status instead).\n[HTTP 1.1 status\ncode](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"
- },
- "Relation": {
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relation."
- },
- "type": {
- "description": "The person's relation to the other person. The type can be custom or predefined.\nPossible values include, but are not limited to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner`\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`",
- "type": "string"
- },
- "person": {
- "description": "The name of the other person this relation refers to.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "Relation",
- "description": "A person's relation to another person.",
- "type": "object"
- },
- "Occupation": {
- "description": "A person's occupation.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the occupation."
- },
- "value": {
- "description": "The occupation; for example, `carpenter`.",
- "type": "string"
- }
- },
- "id": "Occupation"
- },
- "Person": {
- "description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data.\n\nMost fields can have multiple items. The items in a field have no guaranteed\norder, but each non-empty field is guaranteed to have exactly one field with\n`metadata.primary` set to true.",
- "type": "object",
- "properties": {
- "urls": {
- "description": "The person's associated URLs.",
- "type": "array",
- "items": {
- "$ref": "Url"
- }
- },
- "nicknames": {
- "description": "The person's nicknames.",
- "type": "array",
- "items": {
- "$ref": "Nickname"
- }
- },
- "names": {
- "description": "The person's names.",
- "type": "array",
- "items": {
- "$ref": "Name"
- }
- },
- "relations": {
- "description": "The person's relations.",
- "type": "array",
- "items": {
- "$ref": "Relation"
- }
- },
- "occupations": {
- "description": "The person's occupations.",
- "type": "array",
- "items": {
- "$ref": "Occupation"
- }
- },
- "emailAddresses": {
- "description": "The person's email addresses.",
- "type": "array",
- "items": {
- "$ref": "EmailAddress"
- }
- },
- "organizations": {
- "description": "The person's past or current organizations.",
- "type": "array",
- "items": {
- "$ref": "Organization"
- }
- },
- "etag": {
- "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
- "type": "string"
- },
- "braggingRights": {
- "description": "The person's bragging rights.",
- "type": "array",
- "items": {
- "$ref": "BraggingRights"
- }
- },
- "metadata": {
- "$ref": "PersonMetadata",
- "description": "Metadata about the person."
- },
- "residences": {
- "description": "The person's residences.",
- "type": "array",
- "items": {
- "$ref": "Residence"
- }
- },
- "genders": {
- "description": "The person's genders.",
- "type": "array",
- "items": {
- "$ref": "Gender"
- }
- },
- "resourceName": {
- "type": "string",
- "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of `people/\u003cperson_id\u003e`."
- },
- "interests": {
- "description": "The person's interests.",
- "type": "array",
- "items": {
- "$ref": "Interest"
- }
- },
- "biographies": {
- "description": "The person's biographies.",
- "type": "array",
- "items": {
- "$ref": "Biography"
- }
- },
- "skills": {
- "description": "The person's skills.",
- "type": "array",
- "items": {
- "$ref": "Skill"
- }
- },
- "relationshipStatuses": {
- "description": "The person's relationship statuses.",
- "type": "array",
- "items": {
- "$ref": "RelationshipStatus"
- }
- },
- "photos": {
- "description": "The person's photos.",
- "type": "array",
- "items": {
- "$ref": "Photo"
- }
- },
- "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": "DEPRECATED(Please read person.age_ranges instead). The person's age range.",
- "type": "string"
- },
- "taglines": {
- "description": "The person's taglines.",
- "type": "array",
- "items": {
- "$ref": "Tagline"
- }
- },
- "ageRanges": {
- "description": "The person's age ranges.",
- "type": "array",
- "items": {
- "$ref": "AgeRangeType"
- }
- },
- "addresses": {
- "description": "The person's street addresses.",
- "type": "array",
- "items": {
- "$ref": "Address"
- }
- },
- "events": {
- "type": "array",
- "items": {
- "$ref": "Event"
- },
- "description": "The person's events."
- },
- "memberships": {
- "type": "array",
- "items": {
- "$ref": "Membership"
- },
- "description": "The person's group memberships."
- },
- "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"
- }
- }
- },
- "id": "Person"
- },
- "GetPeopleResponse": {
- "type": "object",
- "properties": {
- "responses": {
- "type": "array",
- "items": {
- "$ref": "PersonResponse"
- },
- "description": "The response for each requested resource name."
- }
- },
- "id": "GetPeopleResponse"
+ }
}
},
"icons": {
@@ -1175,14 +1175,14 @@
"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/user.emails.read": {
+ "description": "View your email 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.addresses.read": {
+ "description": "View your street addresses"
}
}
}
@@ -1195,61 +1195,139 @@
"ownerName": "Google",
"resources": {
"people": {
+ "methods": {
+ "getBatchGet": {
+ "response": {
+ "$ref": "GetPeopleResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "requestMask.includeField": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Required. Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
+ "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",
+ "https://www.googleapis.com/auth/plus.login",
+ "https://www.googleapis.com/auth/user.addresses.read",
+ "https://www.googleapis.com/auth/user.birthday.read",
+ "https://www.googleapis.com/auth/user.emails.read",
+ "https://www.googleapis.com/auth/user.phonenumbers.read",
+ "https://www.googleapis.com/auth/userinfo.email",
+ "https://www.googleapis.com/auth/userinfo.profile"
+ ],
+ "flatPath": "v1/people:batchGet",
+ "id": "people.people.getBatchGet",
+ "path": "v1/people:batchGet",
+ "description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser."
+ },
+ "get": {
+ "description": "Provides information about a person by specifying a resource name. Use\n`people/me` to indicate the authenticated user.",
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Person"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly",
+ "https://www.googleapis.com/auth/plus.login",
+ "https://www.googleapis.com/auth/user.addresses.read",
+ "https://www.googleapis.com/auth/user.birthday.read",
+ "https://www.googleapis.com/auth/user.emails.read",
+ "https://www.googleapis.com/auth/user.phonenumbers.read",
+ "https://www.googleapis.com/auth/userinfo.email",
+ "https://www.googleapis.com/auth/userinfo.profile"
+ ],
+ "parameters": {
+ "resourceName": {
+ "pattern": "^people/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about any user, specify the resource name that\n identifies the user, such as the resource names returned by\n [`people.connections.list`](/people/api/rest/v1/people.connections/list).",
+ "type": "string",
+ "required": true
+ },
+ "requestMask.includeField": {
+ "type": "string",
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Required. Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`."
+ }
+ },
+ "flatPath": "v1/people/{peopleId}",
+ "id": "people.people.get",
+ "path": "v1/{+resourceName}"
+ }
+ },
"resources": {
"connections": {
"methods": {
"list": {
+ "description": "Provides a list of the authenticated user's contacts merged with any\nlinked profiles.",
"httpMethod": "GET",
- "response": {
- "$ref": "ListConnectionsResponse"
- },
"parameterOrder": [
"resourceName"
],
+ "response": {
+ "$ref": "ListConnectionsResponse"
+ },
"parameters": {
- "sortOrder": {
- "type": "string",
- "location": "query",
- "enum": [
- "LAST_MODIFIED_ASCENDING",
- "FIRST_NAME_ASCENDING",
- "LAST_NAME_ASCENDING"
- ],
- "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`."
- },
"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",
- "location": "query"
+ "type": "boolean"
},
"resourceName": {
- "description": "The resource name to return connections for. Only `people/me` is valid.",
- "required": true,
- "type": "string",
"pattern": "^people/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "The resource name to return connections for. Only `people/me` is valid.",
+ "type": "string",
+ "required": true
},
"pageToken": {
"description": "The token of the page to be returned.",
"type": "string",
"location": "query"
},
+ "pageSize": {
+ "format": "int32",
+ "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defaults to 100.",
+ "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",
+ "description": "Required. Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
"type": "string"
},
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 500, inclusive. Defaults to 100.",
- "format": "int32"
- },
"syncToken": {
"type": "string",
"location": "query",
"description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sync token was created will be returned."
+ },
+ "sortOrder": {
+ "enum": [
+ "LAST_MODIFIED_ASCENDING",
+ "FIRST_NAME_ASCENDING",
+ "LAST_NAME_ASCENDING"
+ ],
+ "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -1257,86 +1335,8 @@
"https://www.googleapis.com/auth/contacts.readonly"
],
"flatPath": "v1/people/{peopleId}/connections",
- "id": "people.people.connections.list",
"path": "v1/{+resourceName}/connections",
- "description": "Provides a list of the authenticated user's contacts merged with any\nlinked profiles."
- }
- }
- }
- },
- "methods": {
- "get": {
- "path": "v1/{+resourceName}",
- "id": "people.people.get",
- "description": "Provides information about a person for a resource name. Use\n`people/me` to indicate the authenticated user.",
- "response": {
- "$ref": "Person"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "resourceName": {
- "pattern": "^people/[^/]+$",
- "location": "path",
- "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about any user, specify the resource name that\n identifies the user, such as the resource names returned by\n [`people.connections.list`](/people/api/rest/v1/people.connections/list).",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly",
- "https://www.googleapis.com/auth/plus.login",
- "https://www.googleapis.com/auth/user.addresses.read",
- "https://www.googleapis.com/auth/user.birthday.read",
- "https://www.googleapis.com/auth/user.emails.read",
- "https://www.googleapis.com/auth/user.phonenumbers.read",
- "https://www.googleapis.com/auth/userinfo.email",
- "https://www.googleapis.com/auth/userinfo.profile"
- ],
- "flatPath": "v1/people/{peopleId}"
- },
- "getBatchGet": {
- "flatPath": "v1/people:batchGet",
- "path": "v1/people:batchGet",
- "id": "people.people.getBatchGet",
- "description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser.",
- "response": {
- "$ref": "GetPeopleResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly",
- "https://www.googleapis.com/auth/plus.login",
- "https://www.googleapis.com/auth/user.addresses.read",
- "https://www.googleapis.com/auth/user.birthday.read",
- "https://www.googleapis.com/auth/user.emails.read",
- "https://www.googleapis.com/auth/user.phonenumbers.read",
- "https://www.googleapis.com/auth/userinfo.email",
- "https://www.googleapis.com/auth/userinfo.profile"
- ],
- "parameters": {
- "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": {
- "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,
- "location": "query"
+ "id": "people.people.connections.list"
}
}
}
@@ -1344,31 +1344,10 @@
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
"enumDescriptions": [
@@ -1405,35 +1384,56 @@
"type": "string"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "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://people.googleapis.com/",
- "servicePath": "",
+ "kind": "discovery#restDescription",
"description": "Provides access to information about profiles and contacts.",
- "kind": "discovery#restDescription"
+ "servicePath": ""
}
diff --git a/people/v1/people-gen.go b/people/v1/people-gen.go
index ad125c0..0b1b829 100644
--- a/people/v1/people-gen.go
+++ b/people/v1/people-gen.go
@@ -1470,7 +1470,12 @@
// Metadata: Metadata about the photo.
Metadata *FieldMetadata `json:"metadata,omitempty"`
- // Url: The URL of the photo.
+ // Url: The URL of the photo. You can change the desired size by
+ // appending a query
+ // parameter `sz=<size>` at the end of the url.
+ // Example:
+ // `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/A
+ // AAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "Metadata") to
@@ -2021,8 +2026,8 @@
header_ http.Header
}
-// Get: Provides information about a person for a resource name.
-// Use
+// Get: Provides information about a person by specifying a resource
+// name. Use
// `people/me` to indicate the authenticated user.
func (r *PeopleService) Get(resourceName string) *PeopleGetCall {
c := &PeopleGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -2031,16 +2036,11 @@
}
// RequestMaskIncludeField sets the optional parameter
-// "requestMask.includeField": Comma-separated list of fields to be
-// included in the response. Omitting
-// this field will include all fields except for connections.list
-// requests,
-// which have a default mask that includes common fields like metadata,
-// name,
-// photo, and profile url.
-// Each path should start with `person.`: for example, `person.names`
-// or
-// `person.photos`.
+// "requestMask.includeField": Required. Comma-separated list of person
+// fields to be included in the
+// response. Each path should start with `person.`: for
+// example,
+// `person.names` or `person.photos`.
func (c *PeopleGetCall) RequestMaskIncludeField(requestMaskIncludeField string) *PeopleGetCall {
c.urlParams_.Set("requestMask.includeField", requestMaskIncludeField)
return c
@@ -2140,7 +2140,7 @@
}
return ret, nil
// {
- // "description": "Provides information about a person for a resource name. Use\n`people/me` to indicate the authenticated user.",
+ // "description": "Provides information about a person by specifying a resource name. Use\n`people/me` to indicate the authenticated user.",
// "flatPath": "v1/people/{peopleId}",
// "httpMethod": "GET",
// "id": "people.people.get",
@@ -2149,7 +2149,7 @@
// ],
// "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`.",
+ // "description": "Required. Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
// "format": "google-fieldmask",
// "location": "query",
// "type": "string"
@@ -2202,16 +2202,11 @@
}
// RequestMaskIncludeField sets the optional parameter
-// "requestMask.includeField": Comma-separated list of fields to be
-// included in the response. Omitting
-// this field will include all fields except for connections.list
-// requests,
-// which have a default mask that includes common fields like metadata,
-// name,
-// photo, and profile url.
-// Each path should start with `person.`: for example, `person.names`
-// or
-// `person.photos`.
+// "requestMask.includeField": Required. Comma-separated list of person
+// fields to be included in the
+// response. Each path should start with `person.`: for
+// example,
+// `person.names` or `person.photos`.
func (c *PeopleGetBatchGetCall) RequestMaskIncludeField(requestMaskIncludeField string) *PeopleGetBatchGetCall {
c.urlParams_.Set("requestMask.includeField", requestMaskIncludeField)
return c
@@ -2328,7 +2323,7 @@
// "parameterOrder": [],
// "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`.",
+ // "description": "Required. Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
// "format": "google-fieldmask",
// "location": "query",
// "type": "string"
@@ -2381,7 +2376,7 @@
// PageSize sets the optional parameter "pageSize": The number of
// connections to include in the response. Valid values are
-// between 1 and 500, inclusive. Defaults to 100.
+// between 1 and 2000, inclusive. Defaults to 100.
func (c *PeopleConnectionsListCall) PageSize(pageSize int64) *PeopleConnectionsListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
@@ -2395,16 +2390,11 @@
}
// RequestMaskIncludeField sets the optional parameter
-// "requestMask.includeField": Comma-separated list of fields to be
-// included in the response. Omitting
-// this field will include all fields except for connections.list
-// requests,
-// which have a default mask that includes common fields like metadata,
-// name,
-// photo, and profile url.
-// Each path should start with `person.`: for example, `person.names`
-// or
-// `person.photos`.
+// "requestMask.includeField": Required. Comma-separated list of person
+// fields to be included in the
+// response. Each path should start with `person.`: for
+// example,
+// `person.names` or `person.photos`.
func (c *PeopleConnectionsListCall) RequestMaskIncludeField(requestMaskIncludeField string) *PeopleConnectionsListCall {
c.urlParams_.Set("requestMask.includeField", requestMaskIncludeField)
return c
@@ -2545,7 +2535,7 @@
// ],
// "parameters": {
// "pageSize": {
- // "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 500, inclusive. Defaults to 100.",
+ // "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defaults to 100.",
// "format": "int32",
// "location": "query",
// "type": "integer"
@@ -2556,7 +2546,7 @@
// "type": "string"
// },
// "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`.",
+ // "description": "Required. Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
// "format": "google-fieldmask",
// "location": "query",
// "type": "string"
diff --git a/playmoviespartner/v1/playmoviespartner-api.json b/playmoviespartner/v1/playmoviespartner-api.json
index 8e22806..e0972ae 100644
--- a/playmoviespartner/v1/playmoviespartner-api.json
+++ b/playmoviespartner/v1/playmoviespartner-api.json
@@ -1,29 +1,11 @@
{
- "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"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "Gets the delivery status of titles for Google Play Movies Partners.",
- "servicePath": "",
- "rootUrl": "https://playmoviespartner.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "playmoviespartner",
"batchPath": "batch",
"id": "playmoviespartner:v1",
"documentationLink": "https://developers.google.com/playmoviespartner/",
- "revision": "20170502",
+ "revision": "20170530",
"title": "Google Play Movies Partner API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"accounts": {
"resources": {
@@ -39,17 +21,17 @@
],
"httpMethod": "GET",
"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",
- "location": "path"
- },
- "availId": {
- "description": "REQUIRED. Avail ID.",
- "required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -61,24 +43,14 @@
"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"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"accountId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ],
+ "response": {
+ "$ref": "ListAvailsResponse"
+ },
"parameters": {
- "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",
@@ -86,10 +58,10 @@
"location": "query"
},
"pphNames": {
- "description": "See _List methods rules_ for info about this field.",
- "type": "string",
"repeated": true,
- "location": "query"
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
},
"altId": {
"location": "query",
@@ -103,10 +75,10 @@
"repeated": true
},
"accountId": {
+ "location": "path",
"description": "REQUIRED. See _General rules_ for more information about this field.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"territories": {
"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\").",
@@ -115,9 +87,9 @@
"location": "query"
},
"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"
+ "type": "string",
+ "location": "query"
},
"pageToken": {
"location": "query",
@@ -125,25 +97,31 @@
"type": "string"
},
"videoIds": {
- "location": "query",
"description": "Filter Avails that match any of the given `video_id`s.",
"type": "string",
- "repeated": true
+ "repeated": true,
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "format": "int32",
+ "type": "integer"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
"flatPath": "v1/accounts/{accountId}/avails",
+ "id": "playmoviespartner.accounts.avails.list",
"path": "v1/accounts/{accountId}/avails",
- "id": "playmoviespartner.accounts.avails.list"
+ "description": "List Avails owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method."
}
}
},
"orders": {
"methods": {
"get": {
- "flatPath": "v1/accounts/{accountId}/orders/{orderId}",
- "path": "v1/accounts/{accountId}/orders/{orderId}",
- "id": "playmoviespartner.accounts.orders.get",
- "description": "Get an Order given its id.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method.",
"response": {
"$ref": "Order"
},
@@ -152,12 +130,15 @@
"orderId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
"parameters": {
"accountId": {
- "location": "path",
"description": "REQUIRED. See _General rules_ for more information about this field.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"orderId": {
"description": "REQUIRED. Order ID.",
@@ -166,15 +147,12 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ]
+ "flatPath": "v1/accounts/{accountId}/orders/{orderId}",
+ "path": "v1/accounts/{accountId}/orders/{orderId}",
+ "id": "playmoviespartner.accounts.orders.get",
+ "description": "Get an Order given its id.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method."
},
"list": {
- "flatPath": "v1/accounts/{accountId}/orders",
- "id": "playmoviespartner.accounts.orders.list",
- "path": "v1/accounts/{accountId}/orders",
- "description": "List Orders owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method.",
"httpMethod": "GET",
"parameterOrder": [
"accountId"
@@ -186,19 +164,37 @@
"https://www.googleapis.com/auth/playmovies_partner.readonly"
],
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "See _List methods rules_ for info about this field.",
- "format": "int32",
- "type": "integer"
+ "videoIds": {
+ "description": "Filter Orders that match any of the given `video_id`s.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
},
- "pphNames": {
+ "customId": {
+ "type": "string",
"location": "query",
+ "description": "Filter Orders that match a case-insensitive, partner-specific custom id."
+ },
+ "pageToken": {
"description": "See _List methods rules_ for info about this field.",
"type": "string",
- "repeated": true
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "See _List methods rules_ for info about this field.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "pphNames": {
+ "repeated": true,
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
},
"status": {
+ "type": "string",
+ "repeated": true,
"location": "query",
"enum": [
"STATUS_UNSPECIFIED",
@@ -208,83 +204,62 @@
"STATUS_UNFULFILLED",
"STATUS_NOT_AVAILABLE"
],
- "description": "Filter Orders that match one of the given status.",
- "type": "string",
- "repeated": true
+ "description": "Filter Orders that match one of the given status."
},
"studioNames": {
- "location": "query",
"description": "See _List methods rules_ for info about this field.",
"type": "string",
- "repeated": true
+ "repeated": true,
+ "location": "query"
},
"name": {
+ "type": "string",
"location": "query",
- "description": "Filter that matches Orders with a `name`, `show`, `season` or `episode`\nthat contains the given case-insensitive name.",
- "type": "string"
+ "description": "Filter that matches Orders with a `name`, `show`, `season` or `episode`\nthat contains the given case-insensitive name."
},
"accountId": {
"location": "path",
"description": "REQUIRED. See _General rules_ for more information about this field.",
"required": true,
"type": "string"
- },
- "videoIds": {
- "description": "Filter Orders that match any of the given `video_id`s.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "customId": {
- "location": "query",
- "description": "Filter Orders that match a case-insensitive, partner-specific custom id.",
- "type": "string"
- },
- "pageToken": {
- "description": "See _List methods rules_ for info about this field.",
- "type": "string",
- "location": "query"
}
- }
+ },
+ "flatPath": "v1/accounts/{accountId}/orders",
+ "id": "playmoviespartner.accounts.orders.list",
+ "path": "v1/accounts/{accountId}/orders",
+ "description": "List Orders owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method."
}
}
},
"storeInfos": {
"methods": {
"list": {
- "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",
"response": {
"$ref": "ListStoreInfosResponse"
},
"parameterOrder": [
"accountId"
],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/playmovies_partner.readonly"
],
"parameters": {
- "seasonIds": {
+ "videoIds": {
"location": "query",
- "description": "Filter StoreInfos that match any of the given `season_id`s.",
+ "description": "Filter StoreInfos that match any of the given `video_id`s.",
"type": "string",
"repeated": true
},
- "videoIds": {
- "description": "Filter StoreInfos that match any of the given `video_id`s.",
+ "videoId": {
+ "description": "Filter StoreInfos that match a given `video_id`.\nNOTE: this field is deprecated and will be removed on V2; `video_ids`\nshould be used instead.",
"type": "string",
- "repeated": true,
"location": "query"
},
- "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": {
+ "type": "string",
"location": "query",
- "description": "See _List methods rules_ for info about this field.",
- "type": "string"
+ "description": "See _List methods rules_ for info about this field."
},
"pageSize": {
"location": "query",
@@ -305,14 +280,8 @@
"location": "query"
},
"countries": {
- "location": "query",
"description": "Filter StoreInfos that match (case-insensitive) any of the given country\ncodes, using the \"ISO 3166-1 alpha-2\" format (examples: \"US\", \"us\", \"Us\").",
"type": "string",
- "repeated": true
- },
- "studioNames": {
- "description": "See _List methods rules_ for info about this field.",
- "type": "string",
"repeated": true,
"location": "query"
},
@@ -321,39 +290,48 @@
"type": "string",
"location": "query"
},
+ "studioNames": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
"accountId": {
"description": "REQUIRED. See _General rules_ for more information about this field.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "seasonIds": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "description": "Filter StoreInfos that match any of the given `season_id`s."
}
},
"flatPath": "v1/accounts/{accountId}/storeInfos",
+ "id": "playmoviespartner.accounts.storeInfos.list",
"path": "v1/accounts/{accountId}/storeInfos",
- "id": "playmoviespartner.accounts.storeInfos.list"
+ "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."
}
},
"resources": {
"country": {
"methods": {
"get": {
- "description": "Get a StoreInfo given its video id and country.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method.",
- "httpMethod": "GET",
+ "response": {
+ "$ref": "StoreInfo"
+ },
"parameterOrder": [
"accountId",
"videoId",
"country"
],
- "response": {
- "$ref": "StoreInfo"
- },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
"parameters": {
- "accountId": {
- "location": "path",
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "required": true,
- "type": "string"
- },
"videoId": {
"location": "path",
"description": "REQUIRED. Video ID.",
@@ -361,18 +339,22 @@
"type": "string"
},
"country": {
- "location": "path",
"description": "REQUIRED. Edit country.",
"required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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}/storeInfos/{videoId}/country/{country}",
+ "path": "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."
}
}
}
@@ -393,21 +375,16 @@
"type": "boolean",
"default": "true"
},
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "fields": {
- "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",
@@ -421,7 +398,17 @@
"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",
@@ -430,43 +417,38 @@
],
"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"
+ "default": "json"
},
"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.",
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
"pp": {
"location": "query",
"description": "Pretty-print response.",
"type": "boolean",
"default": "true"
},
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
}
},
"schemas": {
@@ -474,110 +456,31 @@
"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": {
- "countries": {
- "description": "Countries where the Order is available,\nusing the \"ISO 3166-1 alpha-2\" format (example: \"US\").",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "statusDetail": {
- "description": "Detailed status of the order",
- "type": "string",
- "enumDescriptions": [
- "Value could not be determined, please contact technical support if\nit should.",
- "Approved by Google's Quality Control team.",
- "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"
- ]
- },
- "status": {
- "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"
- ],
- "description": "High-level status of the order.",
- "type": "string"
- },
- "earliestAvailStartTime": {
- "description": "Timestamp of the earliest start date of the Avails\nlinked to this Order.",
+ "approvedTime": {
+ "description": "Timestamp when the Order was approved.",
"format": "google-datetime",
"type": "string"
},
- "name": {
- "description": "Default Edit name,\nusually in the language of the country of origin.\nExample: \"Googlers, The\".",
- "type": "string"
- },
- "studioName": {
- "description": "Name of the studio that owns the Edit ordered.",
- "type": "string"
- },
- "receivedTime": {
- "description": "Timestamp when the Order was fulfilled.",
- "format": "google-datetime",
- "type": "string"
- },
- "seasonName": {
- "description": "Default Season name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The - A Brave New World\".",
- "type": "string"
- },
- "customId": {
- "description": "ID that can be used to externally identify an Order.\nThis ID is provided by partners when submitting the Avails.\nExample: 'GOOGLER_2006'",
- "type": "string"
- },
"channelName": {
"description": "YouTube Channel Name that should be used to fulfill the Order.\nExample: \"Google_channel\".",
"type": "string"
},
- "approvedTime": {
- "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."
- ],
- "enum": [
- "NORMALIZED_PRIORITY_UNSPECIFIED",
- "LOW_PRIORITY",
- "HIGH_PRIORITY"
]
},
"orderId": {
@@ -585,8 +488,6 @@
"type": "string"
},
"type": {
- "description": "Type of the Edit linked to the Order.",
- "type": "string",
"enumDescriptions": [
"Value could not be determined, please contact technical support if\nit should.",
"A movie picture.",
@@ -600,7 +501,9 @@
"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\".",
@@ -610,14 +513,14 @@
"description": "YouTube Channel ID that should be used to fulfill the Order.\nExample: \"UCRG64darCZhb\".",
"type": "string"
},
- "legacyPriority": {
- "description": "Legacy Order priority, as defined by Google.\nExample: 'P0'",
- "type": "string"
- },
"pphName": {
"description": "Name of the post-production house that manages the Edit ordered.",
"type": "string"
},
+ "legacyPriority": {
+ "description": "Legacy Order priority, as defined by Google.\nExample: 'P0'",
+ "type": "string"
+ },
"orderedTime": {
"description": "Timestamp when the Order was created.",
"format": "google-datetime",
@@ -633,7 +536,86 @@
"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",
+ "description": "Default Episode name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The - Pilot\"."
+ },
+ "countries": {
+ "description": "Countries where the Order is available,\nusing the \"ISO 3166-1 alpha-2\" format (example: \"US\").",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "statusDetail": {
+ "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",
+ "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."
+ ]
+ },
+ "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"
+ ]
+ },
+ "earliestAvailStartTime": {
+ "type": "string",
+ "description": "Timestamp of the earliest start date of the Avails\nlinked to this Order.",
+ "format": "google-datetime"
+ },
+ "name": {
+ "description": "Default Edit name,\nusually in the language of the country of origin.\nExample: \"Googlers, The\".",
+ "type": "string"
+ },
+ "studioName": {
+ "type": "string",
+ "description": "Name of the studio that owns the Edit ordered."
+ },
+ "receivedTime": {
+ "description": "Timestamp when the Order was fulfilled.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "seasonName": {
+ "description": "Default Season name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The - A Brave New World\".",
+ "type": "string"
+ },
+ "customId": {
+ "description": "ID that can be used to externally identify an Order.\nThis ID is provided by partners when submitting the Avails.\nExample: 'GOOGLER_2006'",
"type": "string"
}
},
@@ -663,8 +645,6 @@
"id": "ListStoreInfosResponse"
},
"ListAvailsResponse": {
- "description": "Response to the 'ListAvails' method.",
- "type": "object",
"properties": {
"avails": {
"description": "List of Avails that match the request criteria.",
@@ -683,67 +663,219 @@
"type": "integer"
}
},
- "id": "ListAvailsResponse"
+ "id": "ListAvailsResponse",
+ "description": "Response to the 'ListAvails' method.",
+ "type": "object"
+ },
+ "Avail": {
+ "type": "object",
+ "properties": {
+ "ratingReason": {
+ "description": "Value representing the rating reason.\nRating reasons should be formatted as per\n[EMA ratings spec](http://www.movielabs.com/md/ratings/)\nand comma-separated for inclusion of multiple reasons.\nExample: \"L, S, V\"",
+ "type": "string"
+ },
+ "availId": {
+ "description": "ID internally generated by Google to uniquely identify an Avail.\nNot part of EMA Specs.",
+ "type": "string"
+ },
+ "workType": {
+ "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\""
+ ]
+ },
+ "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": {
+ "description": "Type of pricing that should be applied to this Avail\nbased on how the partner classify them.\nExample: \"Tier\", \"WSP\", \"SRP\", or \"Category\".",
+ "type": "string"
+ },
+ "captionIncluded": {
+ "description": "Communicating if caption file will be delivered.",
+ "type": "boolean"
+ },
+ "seasonNumber": {
+ "type": "string",
+ "description": "The number assigned to the season within a series.\nOnly available on TV Avails.\nExample: \"1\"."
+ },
+ "licenseType": {
+ "enum": [
+ "LICENSE_TYPE_UNSPECIFIED",
+ "EST",
+ "VOD",
+ "SVOD",
+ "POEST"
+ ],
+ "description": "Type of transaction.",
+ "type": "string",
+ "enumDescriptions": [
+ "Value could not be determined, please contact technical support if\nit should.",
+ "Electronic Sell Through - purchase policy for unlimited viewing.",
+ "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."
+ ]
+ },
+ "releaseDate": {
+ "description": "Release date of the Title in earliest released territory.\nTypically it is just the year, but it is free-form as per EMA spec.\nExamples: \"1979\", \"Oct 2014\"",
+ "type": "string"
+ },
+ "end": {
+ "description": "End of term in YYYY-MM-DD format in the timezone of the country\nof the Avail.\n\"Open\" if no end date is available.\nExample: \"2019-02-17\"",
+ "type": "string"
+ },
+ "videoId": {
+ "description": "Google-generated ID identifying the video linked to this Avail, once\ndelivered.\nNot part of EMA Specs.\nExample: 'gtry456_xc'",
+ "type": "string"
+ },
+ "start": {
+ "description": "Start of term in YYYY-MM-DD format in the timezone of the\ncountry of the Avail.\nExample: \"2013-05-14\".",
+ "type": "string"
+ },
+ "pphNames": {
+ "description": "Name of the post-production houses that manage the Avail.\nNot part of EMA Specs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "seriesAltId": {
+ "description": "Other identifier referring to the series, as defined by partner.\nOnly available on TV avails.\nExample: \"rs_googlers\".",
+ "type": "string"
+ },
+ "altId": {
+ "type": "string",
+ "description": "Other identifier referring to the Edit, as defined by partner.\nExample: \"GOOGLER_2006\""
+ },
+ "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"
+ ]
+ },
+ "contentId": {
+ "description": "Title Identifier. This should be the Title Level EIDR.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-5\".",
+ "type": "string"
+ },
+ "titleInternalAlias": {
+ "description": "Title used by involved parties to refer to this content.\nExample: \"Googlers, The\".\nOnly available on Movie Avails.",
+ "type": "string"
+ },
+ "ratingValue": {
+ "description": "Value representing the rating.\nRatings should be formatted as per http://www.movielabs.com/md/ratings/\nExample: \"PG\"",
+ "type": "string"
+ },
+ "storeLanguage": {
+ "description": "Spoken language of the intended audience.\nLanguage shall be encoded in accordance with RFC 5646.\nExample: \"fr\".",
+ "type": "string"
+ },
+ "productId": {
+ "type": "string",
+ "description": "Edit Identifier. This should be the Edit Level EIDR.\nExample: \"10.2340/1489-49A2-3956-4B2D-FE16-6\""
+ },
+ "displayName": {
+ "description": "The name of the studio that owns the Edit referred in the Avail.\nThis is the equivalent of `studio_name` in other resources, but it follows\nthe EMA nomenclature.\nExample: \"Google Films\".",
+ "type": "string"
+ },
+ "captionExemption": {
+ "description": "Communicating an exempt category as defined by FCC regulations.\nIt is not required for non-US Avails.\nExample: \"1\"",
+ "type": "string"
+ },
+ "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."
+ },
+ "ListOrdersResponse": {
+ "type": "object",
+ "properties": {
+ "totalSize": {
+ "description": "See _List methods rules_ for more information about this field.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "id": "ListOrdersResponse",
+ "description": "Response to the 'ListOrders' method."
},
"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"
- },
- "hasEstOffer": {
- "description": "Whether the Edit has a EST offer.",
- "type": "boolean"
- },
- "editLevelEidr": {
- "description": "Edit-level EIDR ID.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-6\".",
- "type": "string"
- },
- "hasSdOffer": {
- "description": "Whether the Edit has a SD offer.",
- "type": "boolean"
- },
- "liveTime": {
- "description": "Timestamp when the Edit went live on the Store.",
- "format": "google-datetime",
- "type": "string"
- },
- "videoId": {
- "description": "Google-generated ID identifying the video linked to the Edit.\nExample: 'gtry456_xc'",
- "type": "string"
- },
- "hasInfoCards": {
- "description": "Whether the Edit has info cards.",
- "type": "boolean"
- },
- "hasVodOffer": {
- "description": "Whether the Edit has a VOD offer.",
- "type": "boolean"
- },
- "pphNames": {
- "description": "Name of the post-production houses that manage the Edit.",
- "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": {
- "description": "Name of the studio that owns the Edit ordered.",
- "type": "string"
- },
- "subtitles": {
- "description": "Subtitles available for this Edit.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"audioTracks": {
"description": "Audio tracks available for this Edit.",
"type": "array",
@@ -764,8 +896,6 @@
"type": "string"
},
"type": {
- "description": "Edit type, like Movie, Episode or Season.",
- "type": "string",
"enumDescriptions": [
"Value could not be determined, please contact technical support if\nit should.",
"A movie picture.",
@@ -779,7 +909,9 @@
"SEASON",
"EPISODE",
"BUNDLE"
- ]
+ ],
+ "description": "Edit type, like Movie, Episode or Season.",
+ "type": "string"
},
"trailerId": {
"description": "Google-generated ID identifying the trailer linked to the Edit.\nExample: 'bhd_4e_cx'",
@@ -810,216 +942,66 @@
"type": "string"
},
"seasonName": {
- "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\".",
- "type": "string"
- }
- },
- "id": "StoreInfo"
- },
- "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",
- "properties": {
- "encodeId": {
- "description": "Manifestation Identifier. This should be the Manifestation\nLevel EIDR.\nExample: \"10.2340/1489-49A2-3956-4B2D-FE16-7\"",
- "type": "string"
- },
- "priceType": {
- "description": "Type of pricing that should be applied to this Avail\nbased on how the partner classify them.\nExample: \"Tier\", \"WSP\", \"SRP\", or \"Category\".",
- "type": "string"
- },
- "captionIncluded": {
- "description": "Communicating if caption file will be delivered.",
- "type": "boolean"
+ "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\"."
},
"seasonNumber": {
- "description": "The number assigned to the season within a series.\nOnly available on TV Avails.\nExample: \"1\".",
+ "description": "The number assigned to the season within a show.\nOnly available on TV Edits.\nExample: \"1\".",
"type": "string"
},
- "licenseType": {
- "description": "Type of transaction.",
- "type": "string",
- "enumDescriptions": [
- "Value could not be determined, please contact technical support if\nit should.",
- "Electronic Sell Through - purchase policy for unlimited viewing.",
- "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"
- ]
- },
- "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\"",
+ "editLevelEidr": {
+ "description": "Edit-level EIDR ID.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-6\".",
"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\"",
+ "hasEstOffer": {
+ "description": "Whether the Edit has a EST offer.",
+ "type": "boolean"
+ },
+ "hasSdOffer": {
+ "description": "Whether the Edit has a SD offer.",
+ "type": "boolean"
+ },
+ "liveTime": {
+ "description": "Timestamp when the Edit went live on the Store.",
+ "format": "google-datetime",
"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"
+ "type": "string",
+ "description": "Google-generated ID identifying the video linked to the Edit.\nExample: 'gtry456_xc'"
},
- "start": {
- "description": "Start of term in YYYY-MM-DD format in the timezone of the\ncountry of the Avail.\nExample: \"2013-05-14\".",
- "type": "string"
+ "hasInfoCards": {
+ "description": "Whether the Edit has info cards.",
+ "type": "boolean"
},
- "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"
+ "hasVodOffer": {
+ "description": "Whether the Edit has a VOD offer.",
+ "type": "boolean"
},
"pphNames": {
- "description": "Name of the post-production houses that manage the Avail.\nNot part of EMA Specs.",
+ "description": "Name of the post-production houses that manage the Edit.",
"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\".",
+ "description": "The number assigned to the episode within a season.\nOnly available on TV Edits.\nExample: \"1\".",
"type": "string"
},
- "seriesTitleInternalAlias": {
- "description": "Title used by involved parties to refer to this series.\nOnly available on TV Avails.\nExample: \"Googlers, The\".",
+ "studioName": {
+ "description": "Name of the studio that owns the Edit ordered.",
"type": "string"
},
- "formatProfile": {
- "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"
- ],
- "description": "Indicates the format profile covered by the transaction.",
- "type": "string"
- },
- "contentId": {
- "description": "Title Identifier. This should be the Title Level EIDR.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-5\".",
- "type": "string"
- },
- "titleInternalAlias": {
- "description": "Title used by involved parties to refer to this content.\nExample: \"Googlers, The\".\nOnly available on Movie Avails.",
- "type": "string"
- },
- "ratingValue": {
- "description": "Value representing the rating.\nRatings should be formatted as per http://www.movielabs.com/md/ratings/\nExample: \"PG\"",
- "type": "string"
- },
- "storeLanguage": {
- "description": "Spoken language of the intended audience.\nLanguage shall be encoded in accordance with RFC 5646.\nExample: \"fr\".",
- "type": "string"
- },
- "productId": {
- "description": "Edit Identifier. This should be the Edit Level EIDR.\nExample: \"10.2340/1489-49A2-3956-4B2D-FE16-6\"",
- "type": "string"
- },
- "displayName": {
- "description": "The name of the studio that owns the Edit referred in the Avail.\nThis is the equivalent of `studio_name` in other resources, but it follows\nthe EMA nomenclature.\nExample: \"Google Films\".",
- "type": "string"
- },
- "captionExemption": {
- "description": "Communicating an exempt category as defined by FCC regulations.\nIt is not required for non-US Avails.\nExample: \"1\"",
- "type": "string"
- },
- "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"
- },
- "ratingReason": {
- "description": "Value representing the rating reason.\nRating reasons should be formatted as per\n[EMA ratings spec](http://www.movielabs.com/md/ratings/)\nand comma-separated for inclusion of multiple reasons.\nExample: \"L, S, V\"",
- "type": "string"
- },
- "availId": {
- "description": "ID internally generated by Google to uniquely identify an Avail.\nNot part of EMA Specs.",
- "type": "string"
- },
- "workType": {
- "description": "Work type as enumerated in EMA.",
- "type": "string",
- "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"
- ]
- },
- "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"
- }
- },
- "id": "Avail"
- },
- "ListOrdersResponse": {
- "description": "Response to the 'ListOrders' method.",
- "type": "object",
- "properties": {
- "orders": {
- "description": "List of Orders that match the request criteria.",
+ "subtitles": {
+ "description": "Subtitles available for this Edit.",
"type": "array",
"items": {
- "$ref": "Order"
+ "type": "string"
}
- },
- "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"
+ "id": "StoreInfo"
}
},
"icons": {
@@ -1027,5 +1009,23 @@
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
- "version": "v1"
+ "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"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Gets the delivery status of titles for Google Play Movies Partners.",
+ "servicePath": "",
+ "rootUrl": "https://playmoviespartner.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "playmoviespartner"
}
diff --git a/proximitybeacon/v1beta1/proximitybeacon-api.json b/proximitybeacon/v1beta1/proximitybeacon-api.json
index 411cc0a..cbc59ff 100644
--- a/proximitybeacon/v1beta1/proximitybeacon-api.json
+++ b/proximitybeacon/v1beta1/proximitybeacon-api.json
@@ -1,15 +1,7 @@
{
- "kind": "discovery#restDescription",
- "description": "Registers, manages, indexes, and searches beacons.",
- "servicePath": "",
- "rootUrl": "https://proximitybeacon.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "proximitybeacon",
- "batchPath": "batch",
"id": "proximitybeacon:v1beta1",
+ "revision": "20170517",
"documentationLink": "https://developers.google.com/beacons/proximity/",
- "revision": "20170509",
"title": "Google Proximity Beacon API",
"discoveryVersion": "v1",
"ownerName": "Google",
@@ -27,27 +19,26 @@
"flatPath": "v1beta1/beaconinfo:getforobserved",
"id": "proximitybeacon.beaconinfo.getforobserved",
"path": "v1beta1/beaconinfo:getforobserved",
- "description": "Given one or more beacon observations, returns any beacon information\nand attachments accessible to your application. Authorize by using the\n[API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key)\nfor the application.",
"request": {
"$ref": "GetInfoForObservedBeaconsRequest"
- }
+ },
+ "description": "Given one or more beacon observations, returns any beacon information\nand attachments accessible to your application. Authorize by using the\n[API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key)\nfor the application."
}
}
},
"namespaces": {
"methods": {
"list": {
- "description": "Lists all attachment namespaces owned by your Google Developers Console\nproject. Attachment data associated with a beacon must include a\nnamespaced type, and the namespace must be owned by your project.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
"httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "ListNamespacesResponse"
},
+ "parameterOrder": [],
"parameters": {
"projectId": {
+ "location": "query",
"description": "The project id to list namespaces under.\nOptional.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
"scopes": [
@@ -55,20 +46,24 @@
],
"flatPath": "v1beta1/namespaces",
"id": "proximitybeacon.namespaces.list",
- "path": "v1beta1/namespaces"
+ "path": "v1beta1/namespaces",
+ "description": "Lists all attachment namespaces owned by your Google Developers Console\nproject. Attachment data associated with a beacon must include a\nnamespaced type, and the namespace must be owned by your project.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project."
},
"update": {
+ "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.",
"request": {
"$ref": "Namespace"
},
- "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "namespaceName"
- ],
"response": {
"$ref": "Namespace"
},
+ "parameterOrder": [
+ "namespaceName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
"parameters": {
"namespaceName": {
"pattern": "^namespaces/[^/]+$",
@@ -78,76 +73,75 @@
"type": "string"
},
"projectId": {
- "location": "query",
"description": "The project id of the namespace to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
"flatPath": "v1beta1/namespaces/{namespacesId}",
- "id": "proximitybeacon.namespaces.update",
- "path": "v1beta1/{+namespaceName}"
+ "path": "v1beta1/{+namespaceName}",
+ "id": "proximitybeacon.namespaces.update"
}
}
},
"v1beta1": {
"methods": {
"getEidparams": {
- "path": "v1beta1/eidparams",
- "id": "proximitybeacon.getEidparams",
- "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\nto provision and register multiple beacons. However, clients should be\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon.",
+ "parameterOrder": [],
+ "httpMethod": "GET",
"response": {
"$ref": "EphemeralIdRegistrationParams"
},
- "parameterOrder": [],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
"parameters": {},
- "flatPath": "v1beta1/eidparams"
+ "flatPath": "v1beta1/eidparams",
+ "path": "v1beta1/eidparams",
+ "id": "proximitybeacon.getEidparams",
+ "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\nto provision and register multiple beacons. However, clients should be\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon."
}
}
},
"beacons": {
"methods": {
"get": {
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.get",
"description": "Returns detailed information about the specified beacon.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.\n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon. The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. Clients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast will receive an error.",
+ "response": {
+ "$ref": "Beacon"
+ },
"parameterOrder": [
"beaconName"
],
"httpMethod": "GET",
- "response": {
- "$ref": "Beacon"
- },
- "parameters": {
- "beaconName": {
- "pattern": "^beacons/[^/]+$",
- "location": "path",
- "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "query",
- "description": "The project id of the beacon to request. If the project id is not specified\nthen the project making the request is used. The project id must match the\nproject that owns the beacon.\nOptional.",
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
- "flatPath": "v1beta1/beacons/{beaconsId}"
+ "parameters": {
+ "beaconName": {
+ "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The project id of the beacon to request. If the project id is not specified\nthen the project making the request is used. The project id must match the\nproject that owns the beacon.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "path": "v1beta1/{+beaconName}",
+ "id": "proximitybeacon.beacons.get"
},
"update": {
+ "path": "v1beta1/{+beaconName}",
+ "id": "proximitybeacon.beacons.update",
+ "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be permanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate methods on this API for\nactivation, deactivation, and decommissioning.\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
"request": {
"$ref": "Beacon"
},
- "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be permanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate methods on this API for\nactivation, deactivation, and decommissioning.\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
"response": {
"$ref": "Beacon"
},
@@ -155,76 +149,76 @@
"beaconName"
],
"httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
"parameters": {
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional."
- },
"beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
"description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.",
"required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.update"
- },
- "decommission": {
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
"type": "string"
},
- "beaconName": {
- "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,
+ "projectId": {
+ "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
"type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
+ "location": "query"
}
},
- "flatPath": "v1beta1/beacons/{beaconsId}:decommission",
- "path": "v1beta1/{+beaconName}:decommission",
- "id": "proximitybeacon.beacons.decommission",
+ "flatPath": "v1beta1/beacons/{beaconsId}"
+ },
+ "decommission": {
"description": "Decommissions the specified beacon in the service. This beacon will no\nlonger be returned from `beaconinfo.getforobserved`. This operation is\npermanent -- you will not be able to re-register a beacon with this ID\nagain.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
"response": {
"$ref": "Empty"
},
- "httpMethod": "POST",
"parameterOrder": [
"beaconName"
- ]
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "description": "Beacon that should be decommissioned. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID of the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}:decommission",
+ "path": "v1beta1/{+beaconName}:decommission",
+ "id": "proximitybeacon.beacons.decommission"
},
"delete": {
+ "id": "proximitybeacon.beacons.delete",
+ "path": "v1beta1/{+beaconName}",
"description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"beaconName"
],
- "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
"parameters": {
"beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
"description": "Beacon that should be deleted. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
"required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
+ "type": "string"
},
"projectId": {
"location": "query",
@@ -232,41 +226,44 @@
"type": "string"
}
},
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.delete"
+ "flatPath": "v1beta1/beacons/{beaconsId}"
},
"deactivate": {
- "httpMethod": "POST",
- "parameterOrder": [
- "beaconName"
- ],
+ "path": "v1beta1/{+beaconName}:deactivate",
+ "id": "proximitybeacon.beacons.deactivate",
+ "description": "Deactivates a beacon. Once deactivated, the API will not return\ninformation nor attachment data for the beacon when queried via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nbeacon will do nothing (but will return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
"parameters": {
"beaconName": {
+ "pattern": "^beacons/[^/]+$",
"location": "path",
"description": "Beacon that should be deactivated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
"required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$"
+ "type": "string"
},
"projectId": {
+ "location": "query",
"description": "The project id of the beacon to deactivate. If the project id is not\nspecified then the project making the request is used. The project id must\nmatch the project that owns the beacon.\nOptional.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
- "flatPath": "v1beta1/beacons/{beaconsId}:deactivate",
- "id": "proximitybeacon.beacons.deactivate",
- "path": "v1beta1/{+beaconName}:deactivate",
- "description": "Deactivates a beacon. Once deactivated, the API will not return\ninformation nor attachment data for the beacon when queried via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nbeacon will do nothing (but will return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
+ "flatPath": "v1beta1/beacons/{beaconsId}:deactivate"
},
"register": {
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {
"projectId": {
"location": "query",
@@ -283,26 +280,14 @@
"request": {
"$ref": "Beacon"
},
- "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "response": {
- "$ref": "Beacon"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
+ "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
},
"list": {
- "flatPath": "v1beta1/beacons",
- "id": "proximitybeacon.beacons.list",
- "path": "v1beta1/beacons",
- "description": "Searches the beacon registry for beacons that match the given search\ncriteria. Only those beacons that the client has permission to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
"response": {
"$ref": "ListBeaconsResponse"
},
- "httpMethod": "GET",
"parameterOrder": [],
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
+ "httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
@@ -310,9 +295,9 @@
"type": "string"
},
"q": {
- "location": "query",
"description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -325,33 +310,40 @@
"type": "string",
"location": "query"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons",
+ "path": "v1beta1/beacons",
+ "id": "proximitybeacon.beacons.list",
+ "description": "Searches the beacon registry for beacons that match the given search\ncriteria. Only those beacons that the client has permission to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project."
},
"activate": {
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"beaconName"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
+ "beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "description": "Beacon that should be activated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "type": "string"
+ },
"projectId": {
"location": "query",
"description": "The project id of the beacon to activate. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
"type": "string"
- },
- "beaconName": {
- "description": "Beacon that should be activated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
"flatPath": "v1beta1/beacons/{beaconsId}:activate",
"path": "v1beta1/{+beaconName}:activate",
"id": "proximitybeacon.beacons.activate",
@@ -359,43 +351,171 @@
}
},
"resources": {
+ "attachments": {
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "response": {
+ "$ref": "BeaconAttachment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "description": "Beacon on which the attachment should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "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.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
+ "id": "proximitybeacon.beacons.attachments.create",
+ "path": "v1beta1/{+beaconName}/attachments",
+ "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"
+ }
+ },
+ "batchDelete": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "DeleteAttachmentsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "parameters": {
+ "namespacedType": {
+ "location": "query",
+ "description": "Specifies the namespace and type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional.",
+ "type": "string"
+ },
+ "beaconName": {
+ "description": "The beacon whose attachments should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The project id to delete beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete",
+ "id": "proximitybeacon.beacons.attachments.batchDelete",
+ "path": "v1beta1/{+beaconName}/attachments:batchDelete",
+ "description": "Deletes multiple attachments on a given beacon. This operation is\npermanent and cannot be undone.\n\nYou can optionally specify `namespacedType` to choose which attachments\nshould be deleted. If you do not specify `namespacedType`, all your\nattachments on the given beacon will be deleted. You also may explicitly\nspecify `*/*` to delete all.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
+ },
+ "delete": {
+ "id": "proximitybeacon.beacons.attachments.delete",
+ "path": "v1beta1/{+attachmentName}",
+ "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "attachmentName"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "attachmentName": {
+ "pattern": "^beacons/[^/]+/attachments/[^/]+$",
+ "location": "path",
+ "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\" Eddystone-UID.\nRequired.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBeaconAttachmentsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "parameters": {
+ "namespacedType": {
+ "description": "Specifies the namespace and type of attachment to include in response in\n\u003cvar\u003enamespace/type\u003c/var\u003e format. Accepts `*/*` to specify\n\"all types in all namespaces\".",
+ "type": "string",
+ "location": "query"
+ },
+ "beaconName": {
+ "description": "Beacon whose attachments should be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
+ "id": "proximitybeacon.beacons.attachments.list",
+ "path": "v1beta1/{+beaconName}/attachments",
+ "description": "Returns the attachments for the specified beacon that match the specified\nnamespaced-type pattern.\n\nTo control which namespaced types are returned, you add the\n`namespacedType` query parameter to the request. You must either use\n`*/*`, to return all attachments, or the namespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project."
+ }
+ }
+ },
"diagnostics": {
"methods": {
"list": {
- "description": "List the diagnostics for a single beacon. You can also list diagnostics for\nall the beacons owned by your Google Developers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListDiagnosticsResponse"
},
"parameterOrder": [
"beaconName"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
"parameters": {
- "projectId": {
- "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional.",
- "type": "string",
- "location": "query"
- },
"beaconName": {
+ "pattern": "^beacons/[^/]+$",
"location": "path",
"description": "Beacon that the diagnostics are for.",
"required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
"type": "string"
},
+ "pageToken": {
+ "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
+ "type": "string",
+ "location": "query"
+ },
"pageSize": {
+ "location": "query",
"description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"alertFilter": {
"location": "query",
@@ -406,148 +526,20 @@
],
"description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
"type": "string"
+ },
+ "projectId": {
+ "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional.",
+ "type": "string",
+ "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
"flatPath": "v1beta1/beacons/{beaconsId}/diagnostics",
+ "id": "proximitybeacon.beacons.diagnostics.list",
"path": "v1beta1/{+beaconName}/diagnostics",
- "id": "proximitybeacon.beacons.diagnostics.list"
- }
- }
- },
- "attachments": {
- "methods": {
- "list": {
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "ListBeaconAttachmentsResponse"
- },
- "parameters": {
- "namespacedType": {
- "type": "string",
- "location": "query",
- "description": "Specifies the namespace and type of attachment to include in response in\n\u003cvar\u003enamespace/type\u003c/var\u003e format. Accepts `*/*` to specify\n\"all types in all namespaces\"."
- },
- "beaconName": {
- "pattern": "^beacons/[^/]+$",
- "location": "path",
- "description": "Beacon whose attachments should be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
- "path": "v1beta1/{+beaconName}/attachments",
- "id": "proximitybeacon.beacons.attachments.list",
- "description": "Returns the attachments for the specified beacon that match the specified\nnamespaced-type pattern.\n\nTo control which namespaced types are returned, you add the\n`namespacedType` query parameter to the request. You must either use\n`*/*`, to return all attachments, or the namespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project."
- },
- "create": {
- "response": {
- "$ref": "BeaconAttachment"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "beaconName": {
- "location": "path",
- "description": "Beacon on which the attachment should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$"
- },
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "The project id of the project the attachment will belong to. If\nthe project id is not specified then the project making the request\nis used.\nOptional."
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
- "path": "v1beta1/{+beaconName}/attachments",
- "id": "proximitybeacon.beacons.attachments.create",
- "description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n\u003cul\u003e\n\u003cli\u003eA namespaced type.\u003c/li\u003e\n\u003cli\u003eThe actual attachment data itself.\u003c/li\u003e\n\u003c/ul\u003e\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 characters in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "request": {
- "$ref": "BeaconAttachment"
- }
- },
- "batchDelete": {
- "id": "proximitybeacon.beacons.attachments.batchDelete",
- "path": "v1beta1/{+beaconName}/attachments:batchDelete",
- "description": "Deletes multiple attachments on a given beacon. This operation is\npermanent and cannot be undone.\n\nYou can optionally specify `namespacedType` to choose which attachments\nshould be deleted. If you do not specify `namespacedType`, all your\nattachments on the given beacon will be deleted. You also may explicitly\nspecify `*/*` to delete all.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "httpMethod": "POST",
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "DeleteAttachmentsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "namespacedType": {
- "description": "Specifies the namespace and type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional.",
- "type": "string",
- "location": "query"
- },
- "beaconName": {
- "pattern": "^beacons/[^/]+$",
- "location": "path",
- "description": "The beacon whose attachments should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "The project id to delete beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional."
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "attachmentName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
- "type": "string"
- },
- "attachmentName": {
- "location": "path",
- "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\" Eddystone-UID.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+/attachments/[^/]+$"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
- "id": "proximitybeacon.beacons.attachments.delete",
- "path": "v1beta1/{+attachmentName}",
- "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
+ "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."
}
}
}
@@ -555,31 +547,15 @@
}
},
"parameters": {
- "alt": {
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response."
- },
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"access_token": {
- "type": "string",
"location": "query",
- "description": "OAuth access token."
+ "description": "OAuth access token.",
+ "type": "string"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -613,23 +589,22 @@
"type": "boolean",
"default": "true"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "callback": {
- "description": "JSONP",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"$.xgafv": {
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -639,103 +614,28 @@
"1",
"2"
],
- "description": "V1 error format."
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
}
},
"schemas": {
- "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"
- },
- "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": {
- "attachmentName": {
- "type": "string",
- "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."
- },
- "namespacedType": {
- "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is \u003cvar\u003enamespace/type\u003c/var\u003e. Namespace\nprovides type separation between clients. Type describes the type of\n`data`, for use by the client when parsing the `data` field.\nRequired.",
- "type": "string"
- },
- "data": {
- "description": "An opaque data container for client-provided data. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in responses.\nRequired.",
- "format": "byte",
- "type": "string"
- },
- "creationTimeMs": {
- "type": "string",
- "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.",
- "format": "google-datetime"
- }
- },
- "id": "BeaconAttachment"
- },
- "EphemeralIdRegistration": {
- "type": "object",
- "properties": {
- "initialClockValue": {
- "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.",
- "format": "uint64",
- "type": "string"
- },
- "beaconEcdhPublicKey": {
- "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
- "format": "byte",
- "type": "string"
- },
- "rotationPeriodExponent": {
- "type": "integer",
- "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.",
- "format": "uint32"
- },
- "beaconIdentityKey": {
- "description": "The private key of the beacon. If this field is populated,\n`beacon_ecdh_public_key` and `service_ecdh_public_key` must not be\npopulated.",
- "format": "byte",
- "type": "string"
- },
- "serviceEcdhPublicKey": {
- "description": "The service's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
- "format": "byte",
- "type": "string"
- },
- "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.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "EphemeralIdRegistration",
- "description": "Write-only registration parameters for beacons using Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon with the service\nare supported:\n\n1. Perform an ECDH key exchange via this API, including a previous call\n to `GET /v1beta1/eidparams`. In this case the fields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n populated and `beacon_identity_key` should not be populated. This\n method ensures that only the two parties in the ECDH key exchange can\n compute the identity key, which becomes a secret between them.\n2. Derive or obtain the beacon's identity key via other secure means\n (perhaps an ECDH key exchange between the beacon and a mobile device\n or any other secure method), and then submit the resulting identity key\n to the service. In this case `beacon_identity_key` field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `service_ecdh_public_key` fields should be. The security of this method\n depends on how securely the parties involved (in particular the\n bluetooth client) handle the identity key, and obviously on how\n securely the identity key was generated.\n\nSee [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub."
- },
"LatLng": {
- "id": "LatLng",
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)\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].",
@@ -743,11 +643,14 @@
"type": "number"
},
"longitude": {
- "type": "number",
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "format": "double"
+ "format": "double",
+ "type": "number"
}
- }
+ },
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object"
},
"ListBeaconAttachmentsResponse": {
"description": "Response to `ListBeaconAttachments` that contains the requested attachments.",
@@ -764,8 +667,13 @@
"id": "ListBeaconAttachmentsResponse"
},
"Namespace": {
+ "description": "An attachment namespace defines read and write access for all the attachments\ncreated under it. Each namespace is globally unique, and owned by one\nproject which is the only project that can create attachments under it.",
"type": "object",
"properties": {
+ "namespaceName": {
+ "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
+ "type": "string"
+ },
"servingVisibility": {
"enumDescriptions": [
"Do not use this value.",
@@ -779,30 +687,25 @@
],
"description": "Specifies what clients may receive attachments under this namespace\nvia `beaconinfo.getforobserved`.",
"type": "string"
- },
- "namespaceName": {
- "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
- "type": "string"
}
},
- "id": "Namespace",
- "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."
+ "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": {
- "namespacedType": {
- "type": "string",
- "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"
- },
"data": {
"description": "An opaque data container for client-provided data.",
"format": "byte",
"type": "string"
+ },
+ "namespacedType": {
+ "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is \u003cvar\u003enamespace/type\u003c/var\u003e, for\nexample \u003ccode\u003escrupulous-wombat-12345/welcome-message\u003c/code\u003e",
+ "type": "string"
}
},
- "id": "AttachmentInfo"
+ "id": "AttachmentInfo",
+ "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.",
+ "type": "object"
},
"BeaconInfo": {
"description": "A subset of beacon information served via the `beaconinfo.getforobserved`\nmethod, which you call when users of your app encounter your beacons.",
@@ -813,8 +716,8 @@
"type": "string"
},
"advertisedId": {
- "description": "The ID advertised by the beacon.",
- "$ref": "AdvertisedId"
+ "$ref": "AdvertisedId",
+ "description": "The ID advertised by the beacon."
},
"attachments": {
"description": "Attachments matching the type(s) requested.\nMay be empty if no attachment types were requested.",
@@ -826,6 +729,28 @@
},
"id": "BeaconInfo"
},
+ "EphemeralIdRegistrationParams": {
+ "properties": {
+ "minRotationPeriodExponent": {
+ "description": "Indicates the minimum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "maxRotationPeriodExponent": {
+ "description": "Indicates the maximum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "serviceEcdhPublicKey": {
+ "description": "The beacon service's public key for use by a beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exchange.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "EphemeralIdRegistrationParams",
+ "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"
+ },
"DeleteAttachmentsResponse": {
"description": "Response for a request to delete attachments.",
"type": "object",
@@ -838,36 +763,8 @@
},
"id": "DeleteAttachmentsResponse"
},
- "EphemeralIdRegistrationParams": {
- "properties": {
- "serviceEcdhPublicKey": {
- "description": "The beacon service's public key for use by a beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exchange.",
- "format": "byte",
- "type": "string"
- },
- "minRotationPeriodExponent": {
- "description": "Indicates the minimum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
- "format": "uint32",
- "type": "integer"
- },
- "maxRotationPeriodExponent": {
- "description": "Indicates the maximum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
- "format": "uint32",
- "type": "integer"
- }
- },
- "id": "EphemeralIdRegistrationParams",
- "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"
- },
"Observation": {
- "description": "Represents one beacon observed once.",
- "type": "object",
"properties": {
- "advertisedId": {
- "$ref": "AdvertisedId",
- "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired."
- },
"telemetry": {
"description": "The array of telemetry bytes received from the beacon. The server is\nresponsible for parsing it. This field may frequently be empty, as\nwith a beacon that transmits telemetry only occasionally.",
"format": "byte",
@@ -877,38 +774,44 @@
"description": "Time when the beacon was observed.",
"format": "google-datetime",
"type": "string"
+ },
+ "advertisedId": {
+ "$ref": "AdvertisedId",
+ "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired."
}
},
- "id": "Observation"
+ "id": "Observation",
+ "description": "Represents one beacon observed once.",
+ "type": "object"
},
"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"
}
- },
- "nextPageToken": {
- "description": "Token that can be used for pagination. Returned only if the\nrequest matches more beacons than can be returned in this response.",
- "type": "string"
}
},
- "id": "ListDiagnosticsResponse"
+ "id": "ListDiagnosticsResponse",
+ "description": "Response that contains the requested diagnostics.",
+ "type": "object"
},
"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"
- },
- "description": "Public information about beacons.\nMay be empty if the request matched no beacons."
+ }
}
},
"id": "GetInfoForObservedBeaconsResponse"
@@ -923,6 +826,12 @@
"type": "object"
},
"status": {
+ "enumDescriptions": [
+ "Do not use this value.",
+ "The \"normal\" in-use state of a beacon.",
+ "Beacon should no longer be used for any purpose. This is irreversible.",
+ "The beacon should not be visible to mobile devices. This is reversible."
+ ],
"enum": [
"STATUS_UNSPECIFIED",
"ACTIVE",
@@ -930,17 +839,11 @@
"INACTIVE"
],
"description": "Current status of the beacon.\nRequired.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this value.",
- "The \"normal\" in-use state of a beacon.",
- "Beacon should no longer be used for any purpose. This is irreversible.",
- "The beacon should not be visible to mobile devices. This is reversible."
- ]
+ "type": "string"
},
"indoorLevel": {
- "$ref": "IndoorLevel",
- "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional."
+ "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional.",
+ "$ref": "IndoorLevel"
},
"beaconName": {
"description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.",
@@ -968,26 +871,26 @@
"description": "The identifier of a beacon as advertised by it. This field must be\npopulated when registering. It may be empty when updating a beacon\nrecord because it is ignored in updates.\n\nWhen registering a beacon that broadcasts Eddystone-EID, this field\nshould contain a \"stable\" Eddystone-UID that identifies the beacon and\nlinks it to its attachments. The stable Eddystone-UID is only used for\nadministering the beacon.",
"$ref": "AdvertisedId"
},
- "ephemeralIdRegistration": {
- "$ref": "EphemeralIdRegistration",
- "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error."
- },
"provisioningKey": {
"description": "Some beacons may require a user to provide an authorization key before\nchanging any of its configuration (e.g. broadcast frames, transmit power).\nThis field provides a place to store and control access to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!beaconId`\nfrom users with write access to the given beacon. That is to say: If the\nuser is authorized to write the beacon's confidential data in the service,\nthe service considers them authorized to configure the beacon. Note\nthat this key grants nothing on the service, only on the beacon itself.",
"format": "byte",
"type": "string"
},
- "description": {
- "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
- "type": "string"
+ "ephemeralIdRegistration": {
+ "$ref": "EphemeralIdRegistration",
+ "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error."
+ },
+ "latLng": {
+ "description": "The location of the beacon, expressed as a latitude and longitude pair.\nThis location is given when the beacon is registered or updated. It does\nnot necessarily indicate the actual current location of the beacon.\nOptional.",
+ "$ref": "LatLng"
},
"placeId": {
"description": "The [Google Places API](/places/place-id) Place ID of the place where\nthe beacon is deployed. This is given when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
"type": "string"
},
- "latLng": {
- "$ref": "LatLng",
- "description": "The location of the beacon, expressed as a latitude and longitude pair.\nThis location is given when the beacon is registered or updated. It does\nnot necessarily indicate the actual current location of the beacon.\nOptional."
+ "description": {
+ "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
+ "type": "string"
}
},
"id": "Beacon",
@@ -995,13 +898,10 @@
"type": "object"
},
"AdvertisedId": {
- "id": "AdvertisedId",
"description": "Defines a unique identifier of a beacon as broadcast by the device.",
"type": "object",
"properties": {
"type": {
- "description": "Specifies the identifier type.\nRequired.",
- "type": "string",
"enumDescriptions": [
"Do not use this value.",
"Eddystone, an open beacon format that supports Android and iOS devices\nhttps://github.com/google/eddystone/wiki/Beacon-Specification",
@@ -1015,17 +915,19 @@
"IBEACON",
"ALTBEACON",
"EDDYSTONE_EID"
- ]
+ ],
+ "description": "Specifies the identifier type.\nRequired.",
+ "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.",
"format": "byte",
"type": "string"
}
- }
+ },
+ "id": "AdvertisedId"
},
"IndoorLevel": {
- "id": "IndoorLevel",
"description": "Indoor level, a human-readable string as returned by Google Maps APIs,\nuseful to indicate which floor of a building a beacon is located on.",
"type": "object",
"properties": {
@@ -1033,12 +935,16 @@
"description": "The name of this level.",
"type": "string"
}
- }
+ },
+ "id": "IndoorLevel"
},
"Date": {
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object",
"properties": {
+ "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",
@@ -1048,18 +954,13 @@
"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"
+ "id": "Date",
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "type": "object"
},
"ListNamespacesResponse": {
- "description": "Response to ListNamespacesRequest that contains all the project's namespaces.",
- "type": "object",
"properties": {
"namespaces": {
"description": "The attachments that corresponded to the request params.",
@@ -1069,28 +970,12 @@
}
}
},
- "id": "ListNamespacesResponse"
+ "id": "ListNamespacesResponse",
+ "description": "Response to ListNamespacesRequest that contains all the project's namespaces.",
+ "type": "object"
},
"Diagnostics": {
- "type": "object",
"properties": {
- "alerts": {
- "description": "An unordered list of Alerts that the beacon has.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "ALERT_UNSPECIFIED",
- "WRONG_LOCATION",
- "LOW_BATTERY"
- ]
- },
- "enumDescriptions": [
- "Invalid value. Should never appear.",
- "The beacon has been reported in a location different than its registered\nlocation. This may indicate that the beacon has been moved. This signal\nis not 100% accurate, but indicates that further investigation is worth\nwhile.",
- "The battery level for the beacon is low enough that, given the beacon's\ncurrent use, its battery will run out with in the next 60 days. This\nindicates that the battery should be replaced soon."
- ]
- },
"estimatedLowBatteryDate": {
"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"
@@ -1098,13 +983,30 @@
"beaconName": {
"description": "Resource name of the beacon. For Eddystone-EID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Eddystone-UID.",
"type": "string"
+ },
+ "alerts": {
+ "enumDescriptions": [
+ "Invalid value. Should never appear.",
+ "The beacon has been reported in a location different than its registered\nlocation. This may indicate that the beacon has been moved. This signal\nis not 100% accurate, but indicates that further investigation is worth\nwhile.",
+ "The battery level for the beacon is low enough that, given the beacon's\ncurrent use, its battery will run out with in the next 60 days. This\nindicates that the battery should be replaced soon."
+ ],
+ "description": "An unordered list of Alerts that the beacon has.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "ALERT_UNSPECIFIED",
+ "WRONG_LOCATION",
+ "LOW_BATTERY"
+ ],
+ "type": "string"
+ }
}
},
"id": "Diagnostics",
- "description": "Diagnostics for a single beacon."
+ "description": "Diagnostics for a single beacon.",
+ "type": "object"
},
"ListBeaconsResponse": {
- "id": "ListBeaconsResponse",
"description": "Response that contains list beacon results and pagination help.",
"type": "object",
"properties": {
@@ -1124,14 +1026,104 @@
"format": "int64",
"type": "string"
}
- }
+ },
+ "id": "ListBeaconsResponse"
+ },
+ "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"
+ },
+ "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"
+ },
+ "BeaconAttachment": {
+ "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.",
+ "format": "byte",
+ "type": "string"
+ },
+ "creationTimeMs": {
+ "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "attachmentName": {
+ "description": "Resource name of this attachment. Attachment names have the format:\n\u003ccode\u003ebeacons/\u003cvar\u003ebeacon_id\u003c/var\u003e/attachments/\u003cvar\u003eattachment_id\u003c/var\u003e\u003c/code\u003e.\nLeave this empty on creation.",
+ "type": "string"
+ },
+ "namespacedType": {
+ "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is \u003cvar\u003enamespace/type\u003c/var\u003e. Namespace\nprovides type separation between clients. Type describes the type of\n`data`, for use by the client when parsing the `data` field.\nRequired.",
+ "type": "string"
+ }
+ },
+ "id": "BeaconAttachment",
+ "description": "Project-specific data associated with a beacon.",
+ "type": "object"
+ },
+ "EphemeralIdRegistration": {
+ "properties": {
+ "initialClockValue": {
+ "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "beaconEcdhPublicKey": {
+ "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
+ "format": "byte",
+ "type": "string"
+ },
+ "rotationPeriodExponent": {
+ "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "serviceEcdhPublicKey": {
+ "description": "The service's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
+ "format": "byte",
+ "type": "string"
+ },
+ "beaconIdentityKey": {
+ "description": "The private key of the beacon. If this field is populated,\n`beacon_ecdh_public_key` and `service_ecdh_public_key` must not be\npopulated.",
+ "format": "byte",
+ "type": "string"
+ },
+ "initialEid": {
+ "description": "An initial ephemeral ID calculated using the clock value submitted as\n`initial_clock_value`, and the secret key generated by the\nDiffie-Hellman key exchange using `service_ecdh_public_key` and\n`service_ecdh_public_key`. This initial EID value will be used by the\nservice to confirm that the key exchange process was successful.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "EphemeralIdRegistration",
+ "description": "Write-only registration parameters for beacons using Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon with the service\nare supported:\n\n1. Perform an ECDH key exchange via this API, including a previous call\n to `GET /v1beta1/eidparams`. In this case the fields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n populated and `beacon_identity_key` should not be populated. This\n method ensures that only the two parties in the ECDH key exchange can\n compute the identity key, which becomes a secret between them.\n2. Derive or obtain the beacon's identity key via other secure means\n (perhaps an ECDH key exchange between the beacon and a mobile device\n or any other secure method), and then submit the resulting identity key\n to the service. In this case `beacon_identity_key` field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `service_ecdh_public_key` fields should be. The security of this method\n depends on how securely the parties involved (in particular the\n bluetooth client) handle the identity key, and obviously on how\n securely the identity key was generated.\n\nSee [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
+ "type": "object"
}
},
- "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"version": "v1beta1",
"baseUrl": "https://proximitybeacon.googleapis.com/",
"auth": {
@@ -1142,5 +1134,13 @@
}
}
}
- }
+ },
+ "description": "Registers, manages, indexes, and searches beacons.",
+ "servicePath": "",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://proximitybeacon.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "proximitybeacon",
+ "batchPath": "batch"
}
diff --git a/proximitybeacon/v1beta1/proximitybeacon-gen.go b/proximitybeacon/v1beta1/proximitybeacon-gen.go
index 0e3900c..c158013 100644
--- a/proximitybeacon/v1beta1/proximitybeacon-gen.go
+++ b/proximitybeacon/v1beta1/proximitybeacon-gen.go
@@ -959,10 +959,6 @@
// 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].
diff --git a/pubsub/v1/pubsub-api.json b/pubsub/v1/pubsub-api.json
index f4e09ee..cdc6a24 100644
--- a/pubsub/v1/pubsub-api.json
+++ b/pubsub/v1/pubsub-api.json
@@ -1,4 +1,11 @@
{
+ "ownerDomain": "google.com",
+ "name": "pubsub",
+ "batchPath": "batch",
+ "revision": "20170502",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1",
+ "title": "Google Cloud Pub/Sub API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
@@ -6,155 +13,126 @@
"resources": {
"subscriptions": {
"methods": {
- "testIamPermissions": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
- "id": "pubsub.projects.subscriptions.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"
- }
- },
"modifyPushConfig": {
- "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 name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
"id": "pubsub.projects.subscriptions.modifyPushConfig",
"path": "v1/{+subscription}:modifyPushConfig",
"description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.",
"request": {
"$ref": "ModifyPushConfigRequest"
- }
- },
- "pull": {
+ },
"httpMethod": "POST",
"parameterOrder": [
"subscription"
],
"response": {
- "$ref": "PullResponse"
- },
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription from which messages should be pulled.\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}:pull",
- "id": "pubsub.projects.subscriptions.pull",
- "path": "v1/{+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 messages retained in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription or its topic unless the same topic is specified.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
"$ref": "Empty"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"subscription": {
+ "location": "path",
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig"
+ },
+ "delete": {
+ "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 subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`."
+ }
+ },
+ "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"
+ },
+ "pull": {
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
+ "request": {
+ "$ref": "PullRequest"
+ },
+ "response": {
+ "$ref": "PullResponse"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
+ "path": "v1/{+subscription}:pull",
+ "id": "pubsub.projects.subscriptions.pull"
+ },
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of subscriptions to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "project": {
+ "location": "path",
+ "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
}
},
"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}"
- },
- "list": {
+ "flatPath": "v1/projects/{projectsId}/subscriptions",
+ "path": "v1/{+project}/subscriptions",
+ "id": "pubsub.projects.subscriptions.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": {
- "project": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of subscriptions to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions",
- "path": "v1/{+project}/subscriptions",
- "id": "pubsub.projects.subscriptions.list",
- "description": "Lists matching subscriptions."
+ "httpMethod": "GET"
},
"create": {
"response": {
@@ -170,11 +148,11 @@
],
"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/[^/]+$",
- "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\"`."
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
@@ -186,17 +164,13 @@
}
},
"setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
+ "response": {
+ "$ref": "Policy"
+ },
"parameters": {
"resource": {
"location": "path",
@@ -206,42 +180,17 @@
"pattern": "^projects/[^/]+/subscriptions/[^/]+$"
}
},
- "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"
- }
- },
- "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"
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
},
"acknowledge": {
"response": {
@@ -253,11 +202,11 @@
"httpMethod": "POST",
"parameters": {
"subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path",
"description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
}
},
"scopes": [
@@ -272,43 +221,13 @@
},
"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."
},
- "getIamPolicy": {
- "httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "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": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.get",
- "path": "v1/{+subscription}",
- "description": "Gets the configuration details of a subscription.",
- "httpMethod": "GET",
+ "modifyAckDeadline": {
+ "httpMethod": "POST",
"parameterOrder": [
"subscription"
],
"response": {
- "$ref": "Subscription"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -316,85 +235,115 @@
],
"parameters": {
"subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
}
- }
- }
- }
- },
- "snapshots": {
- "methods": {
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline",
+ "path": "v1/{+subscription}: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"
+ }
+ },
+ "getIamPolicy": {
+ "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.",
+ "httpMethod": "GET",
"response": {
"$ref": "Policy"
},
+ "parameterOrder": [
+ "resource"
+ ],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {
"resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$"
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "Subscription"
+ },
+ "httpMethod": "GET",
+ "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}/snapshots/{snapshotsId}:setIamPolicy",
- "id": "pubsub.projects.snapshots.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1/{+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": {
"$ref": "TestIamPermissionsRequest"
},
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "TestIamPermissionsResponse"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"resource": {
"location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$"
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions",
- "id": "pubsub.projects.snapshots.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions"
- },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.subscriptions.testIamPermissions"
+ }
+ }
+ },
+ "snapshots": {
+ "methods": {
"getIamPolicy": {
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "Policy"
},
+ "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.",
@@ -411,54 +360,179 @@
"flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy",
"id": "pubsub.projects.snapshots.getIamPolicy",
"path": "v1/{+resource}:getIamPolicy"
+ },
+ "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/[^/]+/snapshots/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.snapshots.setIamPolicy"
+ },
+ "testIamPermissions": {
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}: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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "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."
+ }
+ }
}
}
},
"topics": {
- "resources": {
- "subscriptions": {
- "methods": {
- "list": {
- "description": "Lists the name of the subscriptions for this topic.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListTopicSubscriptionsResponse"
- },
- "parameterOrder": [
- "topic"
- ],
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of subscription names to return.",
- "format": "int32",
- "type": "integer"
- },
- "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",
- "id": "pubsub.projects.topics.subscriptions.list",
- "path": "v1/{+topic}/subscriptions"
- }
- }
- }
- },
"methods": {
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy"
+ },
+ "get": {
+ "id": "pubsub.projects.topics.get",
+ "path": "v1/{+topic}",
+ "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}"
+ },
+ "publish": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "topic"
+ ],
+ "response": {
+ "$ref": "PublishResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "topic": {
+ "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish",
+ "id": "pubsub.projects.topics.publish",
+ "path": "v1/{+topic}:publish",
+ "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.",
+ "request": {
+ "$ref": "PublishRequest"
+ }
+ },
+ "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.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions"
+ },
"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",
@@ -470,11 +544,11 @@
},
"parameters": {
"topic": {
- "location": "path",
- "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`."
}
},
"scopes": [
@@ -486,27 +560,15 @@
"path": "v1/{+topic}"
},
"list": {
- "flatPath": "v1/projects/{projectsId}/topics",
- "path": "v1/{+project}/topics",
- "id": "pubsub.projects.topics.list",
"description": "Lists matching topics.",
- "response": {
- "$ref": "ListTopicsResponse"
- },
"parameterOrder": [
"project"
],
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
"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": {
"location": "query",
"description": "Maximum number of topics to return.",
@@ -514,51 +576,70 @@
"type": "integer"
},
"project": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
"description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
"required": true,
+ "type": "string"
+ },
+ "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",
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "location": "query"
}
- }
- },
- "create": {
- "id": "pubsub.projects.topics.create",
- "path": "v1/{+name}",
- "description": "Creates the given topic with the given name.",
- "request": {
- "$ref": "Topic"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Topic"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "flatPath": "v1/projects/{projectsId}/topics",
+ "path": "v1/{+project}/topics",
+ "id": "pubsub.projects.topics.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
"parameters": {
"name": {
- "location": "path",
"description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1/{+name}",
+ "id": "pubsub.projects.topics.create",
+ "request": {
+ "$ref": "Topic"
+ },
+ "description": "Creates the given topic with the given name."
},
"setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.topics.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
"response": {
"$ref": "Policy"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
@@ -571,124 +652,50 @@
"pattern": "^projects/[^/]+/topics/[^/]+$",
"location": "path"
}
- },
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
- "id": "pubsub.projects.topics.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
}
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "list": {
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/subscriptions",
+ "path": "v1/{+topic}/subscriptions",
+ "id": "pubsub.projects.topics.subscriptions.list",
+ "description": "Lists the name of the subscriptions for this topic.",
+ "parameterOrder": [
+ "topic"
+ ],
+ "response": {
+ "$ref": "ListTopicSubscriptionsResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Maximum number of subscription names to return.",
+ "format": "int32"
+ },
+ "topic": {
+ "description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ }
}
- },
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
- "id": "pubsub.projects.topics.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "topic"
- ],
- "parameters": {
- "topic": {
- "location": "path",
- "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.get",
- "path": "v1/{+topic}",
- "description": "Gets the configuration of a topic."
- },
- "publish": {
- "httpMethod": "POST",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "PublishResponse"
- },
- "parameters": {
- "topic": {
- "location": "path",
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish",
- "id": "pubsub.projects.topics.publish",
- "path": "v1/{+topic}:publish",
- "request": {
- "$ref": "PublishRequest"
- },
- "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute."
- },
- "testIamPermissions": {
- "path": "v1/{+resource}:testIamPermissions",
- "id": "pubsub.projects.topics.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions"
+ }
}
}
}
@@ -696,57 +703,31 @@
}
},
"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": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
+ "type": "string",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"fields": {
- "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
},
"$.xgafv": {
"enumDescriptions": [
@@ -761,13 +742,7 @@
"description": "V1 error format.",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -780,17 +755,156 @@
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
+ "ModifyAckDeadlineRequest": {
+ "description": "Request for the ModifyAckDeadline method.",
+ "type": "object",
+ "properties": {
+ "ackIds": {
+ "description": "List of acknowledgment IDs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "ackDeadlineSeconds": {
+ "description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ModifyAckDeadlineRequest"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "PubsubMessage": {
+ "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional attributes for this message.",
+ "type": "object"
+ },
+ "messageId": {
+ "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
+ "type": "string"
+ },
+ "publishTime": {
+ "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "data": {
+ "description": "The message payload.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "PubsubMessage"
+ },
+ "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",
+ "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"
+ },
+ "AcknowledgeRequest": {
+ "properties": {
+ "ackIds": {
+ "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "AcknowledgeRequest",
+ "description": "Request for the Acknowledge method.",
+ "type": "object"
+ },
+ "Empty": {
+ "type": "object",
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
+ },
"ListTopicsResponse": {
"description": "Response for the `ListTopics` method.",
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`."
+ "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
+ "type": "string"
},
"topics": {
"description": "The resulting topics.",
@@ -802,45 +916,27 @@
},
"id": "ListTopicsResponse"
},
- "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"
- }
- }
- }
- },
- "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 `{}`."
- },
"ListTopicSubscriptionsResponse": {
- "description": "Response for the `ListTopicSubscriptions` method.",
"type": "object",
"properties": {
- "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"
+ },
+ "subscriptions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The names of the subscriptions that match the request."
}
},
- "id": "ListTopicSubscriptionsResponse"
+ "id": "ListTopicSubscriptionsResponse",
+ "description": "Response for the `ListTopicSubscriptions` method."
},
"PullResponse": {
+ "description": "Response for the `Pull` method.",
+ "type": "object",
"properties": {
"receivedMessages": {
"description": "Received Pub/Sub messages. The Pub/Sub system will return zero messages if\nthere are no more available in the backlog. The Pub/Sub system may return\nfewer than the `maxMessages` requested even if there are more messages\navailable in the backlog.",
@@ -850,19 +946,17 @@
}
}
},
- "id": "PullResponse",
- "description": "Response for the `Pull` method.",
- "type": "object"
+ "id": "PullResponse"
},
"ReceivedMessage": {
"properties": {
- "message": {
- "$ref": "PubsubMessage",
- "description": "The message."
- },
"ackId": {
"description": "This ID can be used to acknowledge the received message.",
"type": "string"
+ },
+ "message": {
+ "$ref": "PubsubMessage",
+ "description": "The message."
}
},
"id": "ReceivedMessage",
@@ -878,11 +972,11 @@
"type": "string"
},
"attributes": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API."
+ "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
+ "type": "object"
}
},
"id": "PushConfig"
@@ -902,7 +996,6 @@
"id": "TestIamPermissionsResponse"
},
"PullRequest": {
- "description": "Request for the `Pull` method.",
"type": "object",
"properties": {
"maxMessages": {
@@ -915,7 +1008,8 @@
"type": "boolean"
}
},
- "id": "PullRequest"
+ "id": "PullRequest",
+ "description": "Request for the `Pull` method."
},
"ListSubscriptionsResponse": {
"description": "Response for the `ListSubscriptions` method.",
@@ -954,21 +1048,19 @@
"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"
},
"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",
@@ -981,13 +1073,16 @@
"topic": {
"description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
"type": "string"
+ },
+ "pushConfig": {
+ "$ref": "PushConfig",
+ "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods."
}
},
- "id": "Subscription",
- "description": "A subscription resource.",
- "type": "object"
+ "id": "Subscription"
},
"TestIamPermissionsRequest": {
+ "id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -998,11 +1093,9 @@
"type": "string"
}
}
- },
- "id": "TestIamPermissionsRequest"
+ }
},
"Topic": {
- "description": "A topic resource.",
"type": "object",
"properties": {
"name": {
@@ -1010,124 +1103,38 @@
"type": "string"
}
},
- "id": "Topic"
+ "id": "Topic",
+ "description": "A topic resource."
},
"Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
+ "etag": {
+ "type": "string",
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte"
+ },
+ "version": {
+ "type": "integer",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32"
+ },
"bindings": {
"description": "Associates a list of `members` to a `role`.\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",
- "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)."
- },
- "ModifyAckDeadlineRequest": {
- "description": "Request for the ModifyAckDeadline method.",
- "type": "object",
- "properties": {
- "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"
- },
- "ackIds": {
- "description": "List of acknowledgment IDs.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ModifyAckDeadlineRequest"
- },
- "SetIamPolicyRequest": {
- "type": "object",
- "properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- }
- },
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method."
- },
- "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": {
- "type": "object",
- "properties": {
- "attributes": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional attributes for this message.",
- "type": "object"
- },
- "messageId": {
- "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
- "type": "string"
- },
- "publishTime": {
- "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
- "format": "google-datetime",
- "type": "string"
- },
- "data": {
- "description": "The message payload.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "PubsubMessage",
- "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute."
- },
- "Binding": {
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `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`."
+ "id": "Policy"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"version": "v1",
"baseUrl": "https://pubsub.googleapis.com/",
@@ -1145,15 +1152,8 @@
}
},
"kind": "discovery#restDescription",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
"servicePath": "",
+ "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
"rootUrl": "https://pubsub.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "pubsub",
- "batchPath": "batch",
- "id": "pubsub:v1",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "revision": "20170329",
- "title": "Google Cloud Pub/Sub API"
+ "basePath": ""
}
diff --git a/pubsub/v1beta1a/pubsub-api.json b/pubsub/v1beta1a/pubsub-api.json
index 09b9091..3a44b45 100644
--- a/pubsub/v1beta1a/pubsub-api.json
+++ b/pubsub/v1beta1a/pubsub-api.json
@@ -1,221 +1,38 @@
{
+ "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"
+ }
+ }
+ }
+ },
+ "servicePath": "",
+ "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://pubsub.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "pubsub",
"batchPath": "batch",
"id": "pubsub:v1beta1a",
"documentationLink": "https://cloud.google.com/pubsub/docs",
- "revision": "20170329",
+ "revision": "20170502",
"title": "Google Cloud Pub/Sub API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
- "subscriptions": {
- "methods": {
- "acknowledge": {
- "request": {
- "$ref": "AcknowledgeRequest"
- },
- "description": "Acknowledges a particular received message: the Pub/Sub system can remove\nthe given message from the subscription. Acknowledging a message whose\nAck deadline has expired may succeed, but the message could have been\nalready redelivered. Acknowledging a message more than once will not\nresult in an error. This is only used for messages received via pull.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/acknowledge",
- "path": "v1beta1a/subscriptions/acknowledge",
- "id": "pubsub.subscriptions.acknowledge"
- },
- "modifyAckDeadline": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/modifyAckDeadline",
- "path": "v1beta1a/subscriptions/modifyAckDeadline",
- "id": "pubsub.subscriptions.modifyAckDeadline",
- "request": {
- "$ref": "ModifyAckDeadlineRequest"
- },
- "description": "Modifies the Ack deadline for a message received from a pull request."
- },
- "pullBatch": {
- "flatPath": "v1beta1a/subscriptions/pullBatch",
- "path": "v1beta1a/subscriptions/pullBatch",
- "id": "pubsub.subscriptions.pullBatch",
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The system is free to return UNAVAILABLE\nif there are too many pull requests outstanding for the given subscription.",
- "request": {
- "$ref": "PullBatchRequest"
- },
- "response": {
- "$ref": "PullBatchResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {}
- },
- "get": {
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The name of the subscription to get.",
- "required": true,
- "type": "string",
- "pattern": "^.+$"
- }
- },
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
- "path": "v1beta1a/subscriptions/{+subscription}",
- "id": "pubsub.subscriptions.get",
- "description": "Gets the configuration details of a subscription."
- },
- "modifyPushConfig": {
- "request": {
- "$ref": "ModifyPushConfigRequest"
- },
- "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/modifyPushConfig",
- "path": "v1beta1a/subscriptions/modifyPushConfig",
- "id": "pubsub.subscriptions.modifyPushConfig"
- },
- "delete": {
- "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to Pull after deletion will return\nNOT_FOUND.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The subscription to delete.",
- "required": true,
- "type": "string",
- "pattern": "^.+$"
- }
- },
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
- "path": "v1beta1a/subscriptions/{+subscription}",
- "id": "pubsub.subscriptions.delete"
- },
- "pull": {
- "flatPath": "v1beta1a/subscriptions/pull",
- "id": "pubsub.subscriptions.pull",
- "path": "v1beta1a/subscriptions/pull",
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "PullResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {}
- },
- "list": {
- "description": "Lists matching subscriptions.",
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "query": {
- "description": "A valid label query expression.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "location": "query",
- "description": "Maximum number of subscriptions to return.",
- "format": "int32",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions",
- "path": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.list"
- },
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Subscription"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.create",
- "path": "v1beta1a/subscriptions"
- }
- }
- },
"topics": {
"methods": {
"get": {
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "path": "v1beta1a/topics/{+topic}",
+ "id": "pubsub.topics.get",
"description": "Gets the configuration of a topic. Since the topic only has the name\nattribute, this method is only useful to check the existence of a topic.\nIf other attributes are added in the future, they will be returned here.",
"response": {
"$ref": "Topic"
@@ -236,34 +53,28 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics/{topicsId}",
- "path": "v1beta1a/topics/{+topic}",
- "id": "pubsub.topics.get"
+ ]
},
"publish": {
- "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
- "request": {
- "$ref": "PublishRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Empty"
- },
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {},
"flatPath": "v1beta1a/topics/publish",
+ "path": "v1beta1a/topics/publish",
"id": "pubsub.topics.publish",
- "path": "v1beta1a/topics/publish"
+ "request": {
+ "$ref": "PublishRequest"
+ },
+ "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST"
},
"delete": {
- "flatPath": "v1beta1a/topics/{topicsId}",
- "path": "v1beta1a/topics/{+topic}",
- "id": "pubsub.topics.delete",
"description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name.",
"response": {
"$ref": "Empty"
@@ -284,53 +95,195 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
- ]
+ ],
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "path": "v1beta1a/topics/{+topic}",
+ "id": "pubsub.topics.delete"
},
"publishBatch": {
+ "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",
+ "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist.",
+ "request": {
+ "$ref": "PublishBatchRequest"
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
+ "type": "string"
+ },
+ "query": {
+ "location": "query",
+ "description": "A valid label query expression.",
+ "type": "string"
+ },
+ "maxResults": {
+ "location": "query",
+ "description": "Maximum number of topics to return.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/topics",
+ "path": "v1beta1a/topics",
+ "id": "pubsub.topics.list",
+ "description": "Lists matching topics."
+ },
+ "create": {
+ "path": "v1beta1a/topics",
+ "id": "pubsub.topics.create",
+ "request": {
+ "$ref": "Topic"
+ },
+ "description": "Creates the given topic with the given name.",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/topics"
+ }
+ }
+ },
+ "subscriptions": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "query": {
+ "location": "query",
+ "description": "A valid label query expression.",
+ "type": "string"
+ },
+ "maxResults": {
+ "location": "query",
+ "description": "Maximum number of subscriptions to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions",
+ "path": "v1beta1a/subscriptions",
+ "id": "pubsub.subscriptions.list",
+ "description": "Lists matching subscriptions."
+ },
+ "create": {
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1a/subscriptions",
+ "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"
+ }
+ },
+ "acknowledge": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
- "$ref": "PublishBatchResponse"
+ "$ref": "Empty"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1beta1a/topics/publishBatch",
- "id": "pubsub.topics.publishBatch",
- "path": "v1beta1a/topics/publishBatch",
+ "flatPath": "v1beta1a/subscriptions/acknowledge",
+ "id": "pubsub.subscriptions.acknowledge",
+ "path": "v1beta1a/subscriptions/acknowledge",
"request": {
- "$ref": "PublishBatchRequest"
+ "$ref": "AcknowledgeRequest"
},
- "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist."
+ "description": "Acknowledges a particular received message: the Pub/Sub system can remove\nthe given message from the subscription. Acknowledging a message whose\nAck deadline has expired may succeed, but the message could have been\nalready redelivered. Acknowledging a message more than once will not\nresult in an error. This is only used for messages received via pull."
},
- "list": {
- "flatPath": "v1beta1a/topics",
- "id": "pubsub.topics.list",
- "path": "v1beta1a/topics",
- "description": "Lists matching topics.",
- "httpMethod": "GET",
+ "modifyAckDeadline": {
+ "httpMethod": "POST",
"parameterOrder": [],
"response": {
- "$ref": "ListTopicsResponse"
+ "$ref": "Empty"
},
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions/modifyAckDeadline",
+ "id": "pubsub.subscriptions.modifyAckDeadline",
+ "path": "v1beta1a/subscriptions/modifyAckDeadline",
+ "request": {
+ "$ref": "ModifyAckDeadlineRequest"
+ },
+ "description": "Modifies the Ack deadline for a message received from a pull request."
+ },
+ "get": {
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "path": "v1beta1a/subscriptions/{+subscription}",
+ "id": "pubsub.subscriptions.get",
+ "description": "Gets the configuration details of a subscription.",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Subscription"
+ },
+ "httpMethod": "GET",
"parameters": {
- "query": {
- "description": "A valid label query expression.",
+ "subscription": {
+ "description": "The name of the subscription to get.",
+ "required": true,
"type": "string",
- "location": "query"
- },
- "maxResults": {
- "description": "Maximum number of topics to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string"
+ "pattern": "^.+$",
+ "location": "path"
}
},
"scopes": [
@@ -338,37 +291,130 @@
"https://www.googleapis.com/auth/pubsub"
]
},
- "create": {
- "request": {
- "$ref": "Topic"
- },
- "description": "Creates the given topic with the given name.",
- "httpMethod": "POST",
- "parameterOrder": [],
+ "pullBatch": {
"response": {
- "$ref": "Topic"
+ "$ref": "PullBatchResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1a/subscriptions/pullBatch",
+ "path": "v1beta1a/subscriptions/pullBatch",
+ "id": "pubsub.subscriptions.pullBatch",
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The system is free to return UNAVAILABLE\nif there are too many pull requests outstanding for the given subscription.",
+ "request": {
+ "$ref": "PullBatchRequest"
+ }
+ },
+ "modifyPushConfig": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1beta1a/topics",
- "id": "pubsub.topics.create",
- "path": "v1beta1a/topics"
+ "flatPath": "v1beta1a/subscriptions/modifyPushConfig",
+ "path": "v1beta1a/subscriptions/modifyPushConfig",
+ "id": "pubsub.subscriptions.modifyPushConfig",
+ "request": {
+ "$ref": "ModifyPushConfigRequest"
+ },
+ "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified."
+ },
+ "delete": {
+ "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to Pull after deletion will return\nNOT_FOUND.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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"
+ ],
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "id": "pubsub.subscriptions.delete",
+ "path": "v1beta1a/subscriptions/{+subscription}"
+ },
+ "pull": {
+ "flatPath": "v1beta1a/subscriptions/pull",
+ "path": "v1beta1a/subscriptions/pull",
+ "id": "pubsub.subscriptions.pull",
+ "description": "Pulls a single message from the server.\nIf return_immediately is true, and no messages are available in the\nsubscription, this method returns FAILED_PRECONDITION. The system is free\nto return an UNAVAILABLE error if no messages are available in a\nreasonable amount of time (to reduce system load).",
+ "request": {
+ "$ref": "PullRequest"
+ },
+ "response": {
+ "$ref": "PullResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {}
}
}
}
},
"parameters": {
- "callback": {
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "type": "string",
"location": "query",
- "description": "JSONP",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
- "$.xgafv": {
- "description": "V1 error format.",
+ "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": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -377,9 +423,16 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -388,187 +441,31 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "default": "json"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
+ "default": "true",
"location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
}
},
"schemas": {
- "PullRequest": {
- "description": "Request for the Pull method.",
- "type": "object",
- "properties": {
- "subscription": {
- "description": "The subscription from which a message 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 FAILED_PRECONDITION. The client may cancel the request if\nit does not wish to wait any longer for the response.",
- "type": "boolean"
- }
- },
- "id": "PullRequest"
- },
- "PubsubEvent": {
- "description": "An event indicating a received message or truncation event.",
- "type": "object",
- "properties": {
- "truncated": {
- "description": "Indicates that this subscription has been truncated.",
- "type": "boolean"
- },
- "deleted": {
- "description": "Indicates that this subscription has been deleted. (Note that pull\nsubscribers will always receive NOT_FOUND in response in their pull\nrequest on the subscription, rather than seeing this boolean.)",
- "type": "boolean"
- },
- "message": {
- "$ref": "PubsubMessage",
- "description": "A received message."
- },
- "subscription": {
- "description": "The subscription that received the event.",
- "type": "string"
- }
- },
- "id": "PubsubEvent"
- },
- "ListSubscriptionsResponse": {
- "description": "Response for the ListSubscriptions method.",
- "type": "object",
- "properties": {
- "subscription": {
- "description": "The subscriptions that match the request.",
- "type": "array",
- "items": {
- "$ref": "Subscription"
- }
- },
- "nextPageToken": {
- "description": "If not empty, indicates that there are more subscriptions that match the\nrequest and this value should be passed to the next\n\u003ccode\u003eListSubscriptionsRequest\u003c/code\u003e to continue.",
- "type": "string"
- }
- },
- "id": "ListSubscriptionsResponse"
- },
- "PublishRequest": {
- "description": "Request for the Publish method.",
- "type": "object",
- "properties": {
- "topic": {
- "description": "The message in the request will be published on this topic.",
- "type": "string"
- },
- "message": {
- "description": "The message to publish.",
- "$ref": "PubsubMessage"
- }
- },
- "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": {
- "$ref": "PushConfig",
- "description": "If push delivery is used with this subscription, this field is\nused to configure it."
- }
- },
- "id": "Subscription"
- },
- "PublishBatchResponse": {
- "description": "Response for the PublishBatch method.",
- "type": "object",
- "properties": {
- "messageIds": {
- "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PublishBatchResponse"
- },
- "Topic": {
- "description": "A topic resource.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the topic.",
- "type": "string"
- }
- },
- "id": "Topic"
- },
"Label": {
"description": "A key-value pair applied to a given object.",
"type": "object",
@@ -590,12 +487,11 @@
"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"
+ "type": "string",
+ "description": "Next Index: 5\nThe name of the subscription from which messages are being pulled."
},
"ackId": {
"description": "The acknowledgment ID. Either this or ack_ids must be populated,\nnot both.",
@@ -614,12 +510,16 @@
}
}
},
- "id": "ModifyAckDeadlineRequest"
+ "id": "ModifyAckDeadlineRequest",
+ "description": "Request for the ModifyAckDeadline method."
},
"PullBatchRequest": {
- "description": "Request for the PullBatch 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"
+ },
"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",
@@ -628,13 +528,10 @@
"subscription": {
"description": "The subscription from which messages should be pulled.",
"type": "string"
- },
- "returnImmediately": {
- "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
- "type": "boolean"
}
},
- "id": "PullBatchRequest"
+ "id": "PullBatchRequest",
+ "description": "Request for the PullBatch method."
},
"ModifyPushConfigRequest": {
"description": "Request for the ModifyPushConfig method.",
@@ -645,8 +542,8 @@
"type": "string"
},
"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."
+ "description": "An empty \u003ccode\u003epush_config\u003c/code\u003e indicates that the Pub/Sub system should\npause pushing messages from the given subscription.",
+ "$ref": "PushConfig"
}
},
"id": "ModifyPushConfigRequest"
@@ -672,55 +569,13 @@
}
},
"publishTime": {
+ "type": "string",
"description": "The time at which the message was published.\nThe time is milliseconds since the UNIX epoch.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
}
},
"id": "PubsubMessage"
},
- "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"
- },
- "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"
- },
- "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",
@@ -753,6 +608,48 @@
},
"id": "AcknowledgeRequest"
},
+ "ListTopicsResponse": {
+ "id": "ListTopicsResponse",
+ "description": "Response for the ListTopics method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "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."
+ },
+ "topic": {
+ "description": "The resulting topics.",
+ "type": "array",
+ "items": {
+ "$ref": "Topic"
+ }
+ }
+ }
+ },
+ "PublishBatchRequest": {
+ "properties": {
+ "topic": {
+ "description": "The messages in the request will be published on this topic.",
+ "type": "string"
+ },
+ "messages": {
+ "description": "The messages to publish.",
+ "type": "array",
+ "items": {
+ "$ref": "PubsubMessage"
+ }
+ }
+ },
+ "id": "PublishBatchRequest",
+ "description": "Request for the PublishBatch method.",
+ "type": "object"
+ },
+ "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"
+ },
"PullResponse": {
"description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated.",
"type": "object",
@@ -762,8 +659,8 @@
"type": "string"
},
"pubsubEvent": {
- "description": "A pubsub message or truncation event.",
- "$ref": "PubsubEvent"
+ "$ref": "PubsubEvent",
+ "description": "A pubsub message or truncation event."
}
},
"id": "PullResponse"
@@ -778,30 +675,133 @@
}
},
"id": "PushConfig"
+ },
+ "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 FAILED_PRECONDITION. The client may cancel the request if\nit does not wish to wait any longer for the response.",
+ "type": "boolean"
+ },
+ "subscription": {
+ "description": "The subscription from which a message should be pulled.",
+ "type": "string"
+ }
+ },
+ "id": "PullRequest"
+ },
+ "ListSubscriptionsResponse": {
+ "description": "Response for the ListSubscriptions method.",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "description": "The subscriptions that match the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Subscription"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If not empty, indicates that there are more subscriptions that match the\nrequest and this value should be passed to the next\n\u003ccode\u003eListSubscriptionsRequest\u003c/code\u003e to continue."
+ }
+ },
+ "id": "ListSubscriptionsResponse"
+ },
+ "PubsubEvent": {
+ "description": "An event indicating a received message or truncation event.",
+ "type": "object",
+ "properties": {
+ "truncated": {
+ "description": "Indicates that this subscription has been truncated.",
+ "type": "boolean"
+ },
+ "deleted": {
+ "description": "Indicates that this subscription has been deleted. (Note that pull\nsubscribers will always receive NOT_FOUND in response in their pull\nrequest on the subscription, rather than seeing this boolean.)",
+ "type": "boolean"
+ },
+ "message": {
+ "$ref": "PubsubMessage",
+ "description": "A received message."
+ },
+ "subscription": {
+ "description": "The subscription that received the event.",
+ "type": "string"
+ }
+ },
+ "id": "PubsubEvent"
+ },
+ "PublishRequest": {
+ "type": "object",
+ "properties": {
+ "topic": {
+ "type": "string",
+ "description": "The message in the request will be published on this topic."
+ },
+ "message": {
+ "$ref": "PubsubMessage",
+ "description": "The message to publish."
+ }
+ },
+ "id": "PublishRequest",
+ "description": "Request for the Publish method."
+ },
+ "PublishBatchResponse": {
+ "description": "Response for the PublishBatch method.",
+ "type": "object",
+ "properties": {
+ "messageIds": {
+ "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "PublishBatchResponse"
+ },
+ "Subscription": {
+ "description": "A subscription resource.",
+ "type": "object",
+ "properties": {
+ "topic": {
+ "description": "The name of the topic from which this subscription is receiving messages.",
+ "type": "string"
+ },
+ "pushConfig": {
+ "$ref": "PushConfig",
+ "description": "If push delivery is used with this subscription, this field is\nused to configure it."
+ },
+ "ackDeadlineSeconds": {
+ "description": "For either push or pull delivery, the value is the maximum time after a\nsubscriber receives a message before the subscriber should acknowledge or\nNack the message. If the Ack deadline for a message passes without an\nAck or a Nack, the Pub/Sub system will eventually redeliver the message.\nIf a subscriber acknowledges after the deadline, the Pub/Sub system may\naccept the Ack, but it is possible that the message has been already\ndelivered again. Multiple Acks to the message are allowed and will\nsucceed.\n\nFor push delivery, this value is used to set the request timeout for\nthe call to the push endpoint.\n\nFor pull delivery, this value is used as the initial value for the Ack\ndeadline. It may be overridden for each message using its corresponding\nack_id with \u003ccode\u003eModifyAckDeadline\u003c/code\u003e.\nWhile a message is outstanding (i.e. it has been delivered to a pull\nsubscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub\nsystem will not deliver that message to another pull subscriber\n(on a best-effort basis).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the subscription.",
+ "type": "string"
+ }
+ },
+ "id": "Subscription"
+ },
+ "Topic": {
+ "description": "A topic resource.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the topic.",
+ "type": "string"
+ }
+ },
+ "id": "Topic"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"version": "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"
- }
- }
- }
- },
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "rootUrl": "https://pubsub.googleapis.com/"
+ "baseUrl": "https://pubsub.googleapis.com/"
}
diff --git a/pubsub/v1beta2/pubsub-api.json b/pubsub/v1beta2/pubsub-api.json
index 32e6b9a..4669729 100644
--- a/pubsub/v1beta2/pubsub-api.json
+++ b/pubsub/v1beta2/pubsub-api.json
@@ -1,4 +1,644 @@
{
+ "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": "v1beta2",
+ "baseUrl": "https://pubsub.googleapis.com/",
+ "canonicalName": "Pubsub",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/pubsub": {
+ "description": "View and manage Pub/Sub topics and subscriptions"
+ }
+ }
+ }
+ },
+ "servicePath": "",
+ "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://pubsub.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "pubsub",
+ "batchPath": "batch",
+ "revision": "20170502",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1beta2",
+ "title": "Google Cloud Pub/Sub API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "resources": {
+ "projects": {
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.subscriptions.testIamPermissions"
+ },
+ "modifyPushConfig": {
+ "id": "pubsub.projects.subscriptions.modifyPushConfig",
+ "path": "v1beta2/{+subscription}:modifyPushConfig",
+ "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.",
+ "request": {
+ "$ref": "ModifyPushConfigRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "description": "The name of the subscription.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig"
+ },
+ "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.",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "subscription": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The subscription to delete."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1beta2/{+subscription}",
+ "id": "pubsub.projects.subscriptions.delete"
+ },
+ "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",
+ "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"
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of subscriptions to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "project": {
+ "description": "The name of the cloud project that subscriptions belong to.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
+ "id": "pubsub.projects.subscriptions.list",
+ "path": "v1beta2/{+project}/subscriptions",
+ "description": "Lists matching subscriptions.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ }
+ },
+ "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"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy"
+ },
+ "create": {
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1beta2/{+name}",
+ "id": "pubsub.projects.subscriptions.create",
+ "request": {
+ "$ref": "Subscription"
+ },
+ "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic. Note that\nfor REST API requests, you must specify a name.",
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "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"
+ ]
+ },
+ "acknowledge": {
+ "path": "v1beta2/{+subscription}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge",
+ "request": {
+ "$ref": "AcknowledgeRequest"
+ },
+ "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "subscription": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The subscription whose message is being acknowledged.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge"
+ },
+ "modifyAckDeadline": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The name of the subscription.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline",
+ "path": "v1beta2/{+subscription}: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"
+ }
+ },
+ "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": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy"
+ },
+ "get": {
+ "path": "v1beta2/{+subscription}",
+ "id": "pubsub.projects.subscriptions.get",
+ "description": "Gets the configuration details of a subscription.",
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The name of the subscription to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}"
+ }
+ }
+ },
+ "topics": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "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": {
+ "type": "integer",
+ "location": "query",
+ "description": "Maximum number of topics to return.",
+ "format": "int32"
+ },
+ "project": {
+ "description": "The name of the cloud project that topics belong to.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics",
+ "id": "pubsub.projects.topics.list",
+ "path": "v1beta2/{+project}/topics",
+ "description": "Lists matching topics."
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.topics.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "create": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "id": "pubsub.projects.topics.create",
+ "path": "v1beta2/{+name}",
+ "request": {
+ "$ref": "Topic"
+ },
+ "description": "Creates the given topic with the given name."
+ },
+ "getIamPolicy": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
+ "id": "pubsub.projects.topics.getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "get": {
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "id": "pubsub.projects.topics.get",
+ "path": "v1beta2/{+topic}",
+ "description": "Gets the configuration of a topic.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "topic": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "The name of the topic to get.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "publish": {
+ "response": {
+ "$ref": "PublishResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "topic": {
+ "location": "path",
+ "description": "The messages in the request will be published on this topic.",
+ "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}: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."
+ },
+ "testIamPermissions": {
+ "id": "pubsub.projects.topics.testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "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/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions"
+ },
+ "delete": {
+ "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "topic": {
+ "location": "path",
+ "description": "Name of the topic to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1beta2/{+topic}",
+ "id": "pubsub.projects.topics.delete"
+ }
+ },
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "list": {
+ "description": "Lists the name of the subscriptions for this topic.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "topic"
+ ],
+ "response": {
+ "$ref": "ListTopicSubscriptionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Maximum number of subscription names to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "topic": {
+ "location": "path",
+ "description": "The name of the topic that subscriptions are attached to.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}/subscriptions",
+ "id": "pubsub.projects.topics.subscriptions.list",
+ "path": "v1beta2/{+topic}/subscriptions"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"parameters": {
"upload_protocol": {
"location": "query",
@@ -6,29 +646,22 @@
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "default": "true",
+ "location": "query"
},
"fields": {
- "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "$.xgafv": {
- "description": "V1 error format.",
+ "uploadType": {
"type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -37,9 +670,18 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -51,173 +693,44 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "location": "query"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API 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"
},
"pp": {
- "type": "boolean",
- "default": "true",
"location": "query",
- "description": "Pretty-print response."
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
},
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
}
},
"schemas": {
- "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": {
- "type": "object",
- "properties": {
- "messages": {
- "description": "The messages to publish.",
- "type": "array",
- "items": {
- "$ref": "PubsubMessage"
- }
- }
- },
- "id": "PublishRequest",
- "description": "Request for the Publish method."
- },
- "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": {
- "type": "object",
- "properties": {
- "pushConfig": {
- "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods.",
- "$ref": "PushConfig"
- },
- "ackDeadlineSeconds": {
- "description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using 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",
- "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.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
- "type": "string"
- }
- },
- "id": "Subscription",
- "description": "A subscription resource."
- },
- "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": {
- "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",
- "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)."
- },
- "Topic": {
- "id": "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"
- }
- }
- },
"ModifyAckDeadlineRequest": {
- "description": "Request for the ModifyAckDeadline method.",
"type": "object",
"properties": {
- "ackIds": {
- "description": "List of acknowledgment IDs.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"ackId": {
"description": "The acknowledgment ID. Either this or ack_ids must be populated, but not\nboth.",
"type": "string"
@@ -226,9 +739,17 @@
"description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.",
"format": "int32",
"type": "integer"
+ },
+ "ackIds": {
+ "description": "List of acknowledgment IDs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "ModifyAckDeadlineRequest"
+ "id": "ModifyAckDeadlineRequest",
+ "description": "Request for the ModifyAckDeadline method."
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
@@ -241,31 +762,20 @@
},
"id": "SetIamPolicyRequest"
},
- "ModifyPushConfigRequest": {
- "id": "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."
- }
- }
- },
"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": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional attributes for this message."
+ "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.",
@@ -280,7 +790,20 @@
},
"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",
"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",
@@ -294,11 +817,11 @@
"type": "string"
}
},
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
+ "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.",
@@ -308,15 +831,13 @@
}
}
},
- "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": {}
+ "properties": {},
+ "id": "Empty"
},
"ListTopicsResponse": {
"description": "Response for the `ListTopics` method.",
@@ -327,11 +848,11 @@
"type": "string"
},
"topics": {
+ "description": "The resulting topics.",
"type": "array",
"items": {
"$ref": "Topic"
- },
- "description": "The resulting topics."
+ }
}
},
"id": "ListTopicsResponse"
@@ -384,7 +905,6 @@
"id": "ReceivedMessage"
},
"PushConfig": {
- "description": "Configuration for a push delivery endpoint.",
"type": "object",
"properties": {
"pushEndpoint": {
@@ -392,17 +912,17 @@
"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"
+ "id": "PushConfig",
+ "description": "Configuration for a push delivery endpoint."
},
"TestIamPermissionsResponse": {
- "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -413,663 +933,143 @@
}
},
"id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method."
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
},
"PullRequest": {
"description": "Request for the `Pull` method.",
"type": "object",
"properties": {
- "maxMessages": {
- "type": "integer",
- "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
- "format": "int32"
- },
"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"
+ "type": "boolean",
+ "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the `Pull` response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response."
+ },
+ "maxMessages": {
+ "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"
- }
- },
- "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": "v1beta2",
- "baseUrl": "https://pubsub.googleapis.com/",
- "canonicalName": "Pubsub",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "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"
},
- "https://www.googleapis.com/auth/pubsub": {
- "description": "View and manage Pub/Sub topics and subscriptions"
- }
- }
- }
- },
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
- "rootUrl": "https://pubsub.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "pubsub",
- "batchPath": "batch",
- "revision": "20170329",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "id": "pubsub:v1beta2",
- "title": "Google Cloud Pub/Sub API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
"subscriptions": {
- "methods": {
- "acknowledge": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The subscription whose message is being acknowledged.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
- "path": "v1beta2/{+subscription}:acknowledge",
- "id": "pubsub.projects.subscriptions.acknowledge",
- "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.",
- "request": {
- "$ref": "AcknowledgeRequest"
- }
- },
- "modifyAckDeadline": {
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline",
- "path": "v1beta2/{+subscription}:modifyAckDeadline",
- "request": {
- "$ref": "ModifyAckDeadlineRequest"
- },
- "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "Empty"
- }
- },
- "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"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
- }
- },
- "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": {
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1beta2/{+subscription}",
- "id": "pubsub.projects.subscriptions.get",
- "description": "Gets the configuration details of a subscription.",
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "GET",
- "parameters": {
- "subscription": {
- "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"
- ]
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
- "path": "v1beta2/{+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"
- }
- },
- "modifyPushConfig": {
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The name of the subscription.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
- "id": "pubsub.projects.subscriptions.modifyPushConfig",
- "path": "v1beta2/{+subscription}:modifyPushConfig",
- "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.",
- "request": {
- "$ref": "ModifyPushConfigRequest"
- }
- },
- "delete": {
- "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.",
- "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"
- ]
- },
- "pull": {
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
- "request": {
- "$ref": "PullRequest"
- },
- "response": {
- "$ref": "PullResponse"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription from which messages should be pulled."
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
- "path": "v1beta2/{+subscription}:pull",
- "id": "pubsub.projects.subscriptions.pull"
- },
- "list": {
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "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"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of subscriptions to return.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
- "path": "v1beta2/{+project}/subscriptions",
- "id": "pubsub.projects.subscriptions.list",
- "description": "Lists matching subscriptions."
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/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",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
- },
- "create": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Subscription"
- },
- "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}",
- "id": "pubsub.projects.subscriptions.create",
- "path": "v1beta2/{+name}",
- "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic. Note that\nfor REST API requests, you must specify a name.",
- "request": {
- "$ref": "Subscription"
- }
- }
+ "description": "The subscriptions that match the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Subscription"
}
- },
- "topics": {
- "methods": {
- "publish": {
- "httpMethod": "POST",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "PublishResponse"
- },
- "parameters": {
- "topic": {
- "description": "The messages in the request will be published on this topic.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:publish",
- "id": "pubsub.projects.topics.publish",
- "path": "v1beta2/{+topic}:publish",
- "request": {
- "$ref": "PublishRequest"
- },
- "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute."
- },
- "testIamPermissions": {
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions",
- "id": "pubsub.projects.topics.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "Name of the topic to delete.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "path": "v1beta2/{+topic}",
- "id": "pubsub.projects.topics.delete",
- "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`."
- },
- "list": {
- "description": "Lists matching topics.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "parameterOrder": [
- "project"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "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/[^/]+$"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data."
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/topics",
- "id": "pubsub.projects.topics.list",
- "path": "v1beta2/{+project}/topics"
- },
- "create": {
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.create",
- "path": "v1beta2/{+name}",
- "request": {
- "$ref": "Topic"
- },
- "description": "Creates the given topic with the given name.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Topic"
- },
- "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"
- ]
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "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"
- }
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
- "id": "pubsub.projects.topics.getIamPolicy",
- "path": "v1beta2/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "description": "Gets the configuration of a topic.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "topic"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "topic": {
- "description": "The name of the topic to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.get",
- "path": "v1beta2/{+topic}"
- }
- },
- "resources": {
- "subscriptions": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListTopicSubscriptionsResponse"
- },
- "parameterOrder": [
- "topic"
- ],
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of subscription names to return.",
- "format": "int32",
- "type": "integer"
- },
- "topic": {
- "description": "The name of the topic that subscriptions are attached to.",
- "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}/subscriptions",
- "id": "pubsub.projects.topics.subscriptions.list",
- "path": "v1beta2/{+topic}/subscriptions",
- "description": "Lists the name of the subscriptions for this topic."
- }
- }
- }
+ }
+ },
+ "id": "ListSubscriptionsResponse"
+ },
+ "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": {
+ "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"
+ },
+ "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 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",
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "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": {
+ "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"
}
}
}
diff --git a/runtimeconfig/v1/runtimeconfig-api.json b/runtimeconfig/v1/runtimeconfig-api.json
index 0a547be..2088d5d 100644
--- a/runtimeconfig/v1/runtimeconfig-api.json
+++ b/runtimeconfig/v1/runtimeconfig-api.json
@@ -1,216 +1,15 @@
{
- "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": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "runtimeconfig.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "request": {
- "$ref": "CancelOperationRequest"
- }
- },
- "delete": {
- "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 name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "runtimeconfig.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
- },
- "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": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "runtimeconfig.operations.list"
- }
- }
- }
- },
- "parameters": {
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "version": "v1",
- "baseUrl": "https://runtimeconfig.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
- "servicePath": "",
"basePath": "",
- "id": "runtimeconfig:v1",
- "revision": "20170429",
+ "revision": "20170522",
"documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
+ "id": "runtimeconfig:v1",
"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.",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
"type": "array",
@@ -226,6 +25,10 @@
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
"id": "Status"
@@ -249,23 +52,9 @@
"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.",
- "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."
@@ -277,17 +66,31 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ "id": "Operation"
},
"Empty": {
- "properties": {},
- "id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
@@ -297,19 +100,19 @@
}
},
"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",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/cloudruntimeconfig": {
"description": "Manage your Google Cloud Platform services' runtime configuration"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -318,5 +121,202 @@
"ownerDomain": "google.com",
"name": "runtimeconfig",
"batchPath": "batch",
- "title": "Google Cloud Runtime Configuration API"
+ "title": "Google Cloud Runtime Configuration API",
+ "ownerName": "Google",
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "id": "runtimeconfig.operations.cancel",
+ "path": "v1/{+name}:cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "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/cloudruntimeconfig"
+ ]
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "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": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1/operations",
+ "id": "runtimeconfig.operations.list",
+ "path": "v1/{+name}"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://runtimeconfig.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
+ "servicePath": ""
}
diff --git a/runtimeconfig/v1/runtimeconfig-gen.go b/runtimeconfig/v1/runtimeconfig-gen.go
index e43e5ab..2b66cb6 100644
--- a/runtimeconfig/v1/runtimeconfig-gen.go
+++ b/runtimeconfig/v1/runtimeconfig-gen.go
@@ -246,7 +246,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -279,7 +279,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
@@ -638,9 +638,18 @@
// server doesn't support this method, it returns
// `UNIMPLEMENTED`.
//
-// NOTE: the `name` binding below allows API services to override the
+// NOTE: the `name` binding allows API services to override the
// binding
// to use different resource name schemes, such as `users/*/operations`.
+// To
+// override the binding, API services can add a binding such
+// as
+// "/v1/{name=users/*}/operations" to their service configuration.
+// For backwards compatibility, the default name includes the
+// operations
+// collection id, however overriding users must ensure the name
+// binding
+// is the parent resource, without the operations collection id.
func (r *OperationsService) List(name string) *OperationsListCall {
c := &OperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -762,7 +771,7 @@
}
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`.",
+ // "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
// "flatPath": "v1/operations",
// "httpMethod": "GET",
// "id": "runtimeconfig.operations.list",
@@ -776,7 +785,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "path",
// "pattern": "^operations$",
// "required": true,
diff --git a/runtimeconfig/v1beta1/runtimeconfig-api.json b/runtimeconfig/v1beta1/runtimeconfig-api.json
index 923f5a0..0d2516d 100644
--- a/runtimeconfig/v1beta1/runtimeconfig-api.json
+++ b/runtimeconfig/v1beta1/runtimeconfig-api.json
@@ -1,940 +1,30 @@
{
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "configs": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "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.delete",
- "description": "Deletes a RuntimeConfig resource."
- },
- "list": {
- "id": "runtimeconfig.projects.configs.list",
- "path": "v1beta1/{+parent}/configs",
- "description": "Lists all the RuntimeConfig resources within project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "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"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs"
- },
- "create": {
- "response": {
- "$ref": "RuntimeConfig"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "requestId": {
- "location": "query",
- "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
- "type": "string"
- },
- "parent": {
- "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",
- "path": "v1beta1/{+parent}/configs",
- "id": "runtimeconfig.projects.configs.create",
- "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.",
- "request": {
- "$ref": "RuntimeConfig"
- }
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/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."
- }
- },
- "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"
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy",
- "id": "runtimeconfig.projects.configs.getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy"
- },
- "get": {
- "description": "Gets information about a RuntimeConfig resource.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "RuntimeConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "id": "runtimeconfig.projects.configs.get",
- "path": "v1beta1/{+name}"
- },
- "update": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "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": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
- }
- },
- "resources": {
- "variables": {
- "methods": {
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.variables.testIamPermissions"
- },
- "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",
- "parameters": {
- "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"
- },
- "recursive": {
- "location": "query",
- "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.variables.delete"
- },
- "list": {
- "description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values, unless `return_values` is\ntrue, in which case only variables that user has IAM permission to GetVariable\nwill be returned.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListVariablesResponse"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The path to the RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`."
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
- "id": "runtimeconfig.projects.configs.variables.list",
- "path": "v1beta1/{+parent}/variables"
- },
- "create": {
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "requestId": {
- "location": "query",
- "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
- "type": "string"
- },
- "parent": {
- "description": "The path to the RutimeConfig resource that this variable should belong to.\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"
- }
- },
- "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": {
- "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.",
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "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]`"
- }
- },
- "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"
- },
- "get": {
- "description": "Gets information about a single variable.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "id": "runtimeconfig.projects.configs.variables.get",
- "path": "v1beta1/{+name}"
- },
- "update": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "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]`"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.variables.update",
- "description": "Updates an existing variable with a new value.",
- "request": {
- "$ref": "Variable"
- },
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT"
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- }
- },
- "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": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.operations.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions"
- }
- }
- },
- "waiters": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
- "id": "runtimeconfig.projects.configs.waiters.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes the waiter with the specified name."
- },
- "list": {
- "description": "List waiters within the given configuration.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListWaitersResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
- "id": "runtimeconfig.projects.configs.waiters.list",
- "path": "v1beta1/{+parent}/waiters"
- },
- "get": {
- "response": {
- "$ref": "Waiter"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The fully-qualified name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
- "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.get",
- "description": "Gets information about a single waiter."
- },
- "create": {
- "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": {
- "type": "string",
- "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."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
- "id": "runtimeconfig.projects.configs.waiters.create",
- "path": "v1beta1/{+parent}/waiters",
- "request": {
- "$ref": "Waiter"
- },
- "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a waiter with the\ngiven name will exist (and can be retrieved) prior to the operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "testIamPermissions": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.waiters.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
- "location": "path"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "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": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
"version": "v1beta1",
"baseUrl": "https://runtimeconfig.googleapis.com/",
+ "kind": "discovery#restDescription",
"description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
"servicePath": "",
- "kind": "discovery#restDescription",
"basePath": "",
"id": "runtimeconfig:v1beta1",
"documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
- "revision": "20170429",
+ "revision": "20170522",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- }
- },
- "id": "Operation"
- },
- "SetIamPolicyRequest": {
- "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."
- }
- }
- },
- "Status": {
- "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": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status",
- "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": {
- "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": {
- "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 `{}`."
- },
- "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": {
"description": "The condition that a Waiter resource is waiting for.",
"type": "object",
"properties": {
"cardinality": {
- "$ref": "Cardinality",
- "description": "The cardinality of the `EndCondition`."
+ "description": "The cardinality of the `EndCondition`.",
+ "$ref": "Cardinality"
}
},
"id": "EndCondition"
},
"TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -944,11 +34,10 @@
}
}
},
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
+ "id": "TestIamPermissionsResponse"
},
"ListVariablesResponse": {
+ "description": "Response for the `ListVariables()` method.",
"type": "object",
"properties": {
"variables": {
@@ -963,37 +52,38 @@
"type": "string"
}
},
- "id": "ListVariablesResponse",
- "description": "Response for the `ListVariables()` method."
+ "id": "ListVariablesResponse"
},
"RuntimeConfig": {
+ "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata and a hierarchy of\nvariables.",
+ "type": "object",
"properties": {
- "name": {
- "type": "string",
- "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."
- },
"description": {
"description": "An optional description of the RuntimeConfig object.",
"type": "string"
+ },
+ "name": {
+ "description": "The resource name of a runtime config. The name must have the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an\narbitrary name that matches 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"
}
},
- "id": "RuntimeConfig",
- "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata and a hierarchy of\nvariables.",
- "type": "object"
+ "id": "RuntimeConfig"
},
"WatchVariableRequest": {
"description": "Request for the `WatchVariable()` method.",
"type": "object",
"properties": {
"newerThan": {
- "type": "string",
"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"
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "WatchVariableRequest"
},
"ListWaitersResponse": {
+ "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
@@ -1007,9 +97,21 @@
}
}
},
- "id": "ListWaitersResponse",
- "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.",
- "type": "object"
+ "id": "ListWaitersResponse"
+ },
+ "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": {
"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.",
@@ -1024,8 +126,8 @@
"description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout."
},
"success": {
- "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated.",
- "$ref": "EndCondition"
+ "$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.",
@@ -1048,23 +150,15 @@
},
"id": "Waiter"
},
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
"Variable": {
+ "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).",
"type": "object",
"properties": {
+ "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",
@@ -1091,22 +185,18 @@
"text": {
"description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.",
"type": "string"
- },
- "value": {
- "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.",
- "format": "byte",
- "type": "string"
}
},
- "id": "Variable",
- "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)."
+ "id": "Variable"
},
"Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
"properties": {
"etag": {
- "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.",
@@ -1121,16 +211,145 @@
}
}
},
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "id": "Policy"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "Operation"
+ },
+ "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"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There 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"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "Cardinality": {
+ "description": "A Cardinality condition for the Waiter resource. A cardinality condition is\nmet when the number of variables under a specified path prefix reaches a\npredefined number. For example, if you set a Cardinality condition where\nthe `path` is set to `/foo` and the number of paths is set to 2, the\nfollowing variables would meet the condition in a RuntimeConfig resource:\n\n+ `/foo/variable1 = \"value1\"`\n+ `/foo/variable2 = \"value2\"`\n+ `/bar/variable3 = \"value3\"`\n\nIt would not would not satisify the same condition with the `number` set to\n3, however, because there is only 2 paths that start with `/foo`.\nCardinality conditions are recursive; all subtrees under the specific\npath prefix are counted.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "The root of the variable subtree to monitor. For example, `/foo`.",
+ "type": "string"
+ },
+ "number": {
+ "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Cardinality"
+ },
+ "ListConfigsResponse": {
+ "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",
+ "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"
}
},
- "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud RuntimeConfig",
"auth": {
"oauth2": {
@@ -1148,5 +367,786 @@
"ownerDomain": "google.com",
"name": "runtimeconfig",
"batchPath": "batch",
- "title": "Google Cloud Runtime Configuration API"
+ "title": "Google Cloud Runtime Configuration API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "configs": {
+ "methods": {
+ "create": {
+ "flatPath": "v1beta1/projects/{projectsId}/configs",
+ "path": "v1beta1/{+parent}/configs",
+ "id": "runtimeconfig.projects.configs.create",
+ "request": {
+ "$ref": "RuntimeConfig"
+ },
+ "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.",
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string"
+ },
+ "parent": {
+ "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"
+ ]
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy",
+ "id": "runtimeconfig.projects.configs.setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "getIamPolicy": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/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",
+ "id": "runtimeconfig.projects.configs.getIamPolicy",
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "get": {
+ "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",
+ "description": "Gets information about a RuntimeConfig resource."
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "id": "runtimeconfig.projects.configs.update",
+ "path": "v1beta1/{+name}",
+ "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.",
+ "request": {
+ "$ref": "RuntimeConfig"
+ }
+ },
+ "testIamPermissions": {
+ "id": "runtimeconfig.projects.configs.testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions"
+ },
+ "delete": {
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.delete",
+ "description": "Deletes a RuntimeConfig resource.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+$"
+ }
+ }
+ },
+ "list": {
+ "description": "Lists all the RuntimeConfig resources within project.",
+ "response": {
+ "$ref": "ListConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs",
+ "path": "v1beta1/{+parent}/configs",
+ "id": "runtimeconfig.projects.configs.list"
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.operations.get"
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.operations.testIamPermissions"
+ }
+ }
+ },
+ "waiters": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the waiter with the specified name.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
+ "id": "runtimeconfig.projects.configs.waiters.delete",
+ "path": "v1beta1/{+name}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListWaitersResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The path to the configuration for which you want to get a list of waiters.\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/[^/]+$"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
+ "id": "runtimeconfig.projects.configs.waiters.list",
+ "path": "v1beta1/{+parent}/waiters",
+ "description": "List waiters within the given configuration."
+ },
+ "get": {
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
+ "id": "runtimeconfig.projects.configs.waiters.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets information about a single waiter.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Waiter"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The fully-qualified name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ]
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string"
+ },
+ "parent": {
+ "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",
+ "pattern": "^projects/[^/]+/configs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
+ "path": "v1beta1/{+parent}/waiters",
+ "id": "runtimeconfig.projects.configs.waiters.create",
+ "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": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.waiters.testIamPermissions"
+ }
+ }
+ },
+ "variables": {
+ "methods": {
+ "create": {
+ "request": {
+ "$ref": "Variable"
+ },
+ "description": "Creates a variable within the given configuration. You cannot create\na variable with a name that is a prefix of an existing variable name, or a\nname that has an existing variable name as a prefix.\n\nTo learn more about creating a variable, read the\n[Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables)\ndocumentation.",
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "requestId": {
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the RutimeConfig resource that this variable should belong to.\nThe configuration must exist beforehand; the path must by 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",
+ "path": "v1beta1/{+parent}/variables",
+ "id": "runtimeconfig.projects.configs.variables.create"
+ },
+ "watch": {
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch",
+ "id": "runtimeconfig.projects.configs.variables.watch",
+ "path": "v1beta1/{+name}:watch",
+ "description": "Watches a specific variable and waits for a change in the variable's value.\nWhen there is a change, this method returns the new value or times out.\n\nIf a variable is deleted while being watched, the `variableState` state is\nset to `DELETED` and the method returns the last known variable `value`.\n\nIf you set the deadline for watching to a larger value than internal timeout\n(60 seconds), the current variable value is returned and the `variableState`\nwill be `VARIABLE_STATE_UNSPECIFIED`.\n\nTo learn more about creating a watcher, read the\n[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)\ndocumentation.",
+ "request": {
+ "$ref": "WatchVariableRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Variable"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ }
+ },
+ "get": {
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.variables.get",
+ "description": "Gets information about a single variable.",
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}"
+ },
+ "update": {
+ "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}",
+ "id": "runtimeconfig.projects.configs.variables.update",
+ "path": "v1beta1/{+name}"
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.variables.testIamPermissions"
+ },
+ "delete": {
+ "description": "Deletes a variable or multiple variables.\n\nIf you specify a variable name, then that variable is deleted. If you\nspecify a prefix and `recursive` is true, then all variables with that\nprefix are deleted. You must set a `recursive` to true if you delete\nvariables by prefix.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "recursive": {
+ "location": "query",
+ "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
+ "type": "boolean"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "id": "runtimeconfig.projects.configs.variables.delete",
+ "path": "v1beta1/{+name}"
+ },
+ "list": {
+ "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"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The 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",
+ "pattern": "^projects/[^/]+/configs/[^/]+$"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "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"
+ },
+ "returnValues": {
+ "description": "The flag indicates whether the user wants to return values of variables.\nIf true, then only those variables that user has IAM GetVariable permission\nwill be returned along with their values.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "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"
+ }
+ }
}
diff --git a/runtimeconfig/v1beta1/runtimeconfig-gen.go b/runtimeconfig/v1beta1/runtimeconfig-gen.go
index b8ef57f..566763b 100644
--- a/runtimeconfig/v1beta1/runtimeconfig-gen.go
+++ b/runtimeconfig/v1beta1/runtimeconfig-gen.go
@@ -163,6 +163,7 @@
// 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
@@ -722,7 +723,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -755,7 +756,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
diff --git a/safebrowsing/v4/safebrowsing-api.json b/safebrowsing/v4/safebrowsing-api.json
index 5617fe4..89d8fd4 100644
--- a/safebrowsing/v4/safebrowsing-api.json
+++ b/safebrowsing/v4/safebrowsing-api.json
@@ -1,26 +1,43 @@
{
- "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.",
+ "version": "v4",
+ "baseUrl": "https://safebrowsing.googleapis.com/",
"kind": "discovery#restDescription",
+ "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.",
+ "servicePath": "",
"rootUrl": "https://safebrowsing.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "safebrowsing",
"batchPath": "batch",
- "revision": "20170427",
+ "revision": "20170531",
"documentationLink": "https://developers.google.com/safe-browsing/",
"id": "safebrowsing:v4",
"title": "Google Safe Browsing API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
+ "threatMatches": {
+ "methods": {
+ "find": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "FindThreatMatchesResponse"
+ },
+ "parameters": {},
+ "flatPath": "v4/threatMatches:find",
+ "id": "safebrowsing.threatMatches.find",
+ "path": "v4/threatMatches:find",
+ "request": {
+ "$ref": "FindThreatMatchesRequest"
+ },
+ "description": "Finds the threat entries that match the Safe Browsing lists."
+ }
+ }
+ },
"fullHashes": {
"methods": {
"find": {
- "request": {
- "$ref": "FindFullHashesRequest"
- },
- "description": "Finds the full hashes that match the requested hash prefixes.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
@@ -29,21 +46,30 @@
"parameters": {},
"flatPath": "v4/fullHashes:find",
"id": "safebrowsing.fullHashes.find",
- "path": "v4/fullHashes:find"
+ "path": "v4/fullHashes:find",
+ "request": {
+ "$ref": "FindFullHashesRequest"
+ },
+ "description": "Finds the full hashes that match the requested hash prefixes."
}
}
},
"encodedUpdates": {
"methods": {
"get": {
+ "parameterOrder": [
+ "encodedRequest"
+ ],
"httpMethod": "GET",
"response": {
"$ref": "FetchThreatListUpdatesResponse"
},
- "parameterOrder": [
- "encodedRequest"
- ],
"parameters": {
+ "clientId": {
+ "description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.",
+ "type": "string",
+ "location": "query"
+ },
"clientVersion": {
"location": "query",
"description": "The version of the client implementation.",
@@ -55,16 +81,11 @@
"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}",
- "id": "safebrowsing.encodedUpdates.get",
"path": "v4/encodedUpdates/{encodedRequest}",
+ "id": "safebrowsing.encodedUpdates.get",
"description": ""
}
}
@@ -81,46 +102,46 @@
"flatPath": "v4/threatListUpdates:fetch",
"id": "safebrowsing.threatListUpdates.fetch",
"path": "v4/threatListUpdates:fetch",
+ "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
"request": {
"$ref": "FetchThreatListUpdatesRequest"
- },
- "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once."
+ }
}
}
},
"encodedFullHashes": {
"methods": {
"get": {
- "parameterOrder": [
- "encodedRequest"
- ],
+ "path": "v4/encodedFullHashes/{encodedRequest}",
+ "id": "safebrowsing.encodedFullHashes.get",
+ "description": "",
"response": {
"$ref": "FindFullHashesResponse"
},
"httpMethod": "GET",
+ "parameterOrder": [
+ "encodedRequest"
+ ],
"parameters": {
- "clientId": {
- "location": "query",
- "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
- "type": "string"
- },
- "clientVersion": {
- "type": "string",
- "location": "query",
- "description": "The version of the client implementation."
- },
"encodedRequest": {
- "location": "path",
"description": "A serialized FindFullHashesRequest proto.",
"format": "byte",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
+ },
+ "clientId": {
+ "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
+ "type": "string",
+ "location": "query"
+ },
+ "clientVersion": {
+ "description": "The version of the client implementation.",
+ "type": "string",
+ "location": "query"
}
},
- "flatPath": "v4/encodedFullHashes/{encodedRequest}",
- "path": "v4/encodedFullHashes/{encodedRequest}",
- "id": "safebrowsing.encodedFullHashes.get",
- "description": ""
+ "flatPath": "v4/encodedFullHashes/{encodedRequest}"
}
}
},
@@ -128,10 +149,10 @@
"methods": {
"list": {
"httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "ListThreatListsResponse"
},
+ "parameterOrder": [],
"parameters": {},
"flatPath": "v4/threatLists",
"id": "safebrowsing.threatLists.list",
@@ -139,48 +160,19 @@
"description": "Lists the Safe Browsing threat lists available for download."
}
}
- },
- "threatMatches": {
- "methods": {
- "find": {
- "id": "safebrowsing.threatMatches.find",
- "path": "v4/threatMatches:find",
- "request": {
- "$ref": "FindThreatMatchesRequest"
- },
- "description": "Finds the threat entries that match the Safe Browsing lists.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "FindThreatMatchesResponse"
- },
- "parameters": {},
- "flatPath": "v4/threatMatches:find"
- }
- }
}
},
"parameters": {
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"uploadType": {
"location": "query",
@@ -206,13 +198,11 @@
"type": "string"
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -224,16 +214,18 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
},
- "access_token": {
- "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"
},
- "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"
},
"quotaUser": {
@@ -246,41 +238,139 @@
"type": "boolean",
"default": "true",
"location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"schemas": {
- "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.",
+ "FetchThreatListUpdatesResponse": {
+ "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",
+ "type": "object"
+ },
+ "FindFullHashesResponse": {
+ "properties": {
+ "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"
+ },
+ "matches": {
+ "description": "The full hashes that matched the requested prefixes.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatMatch"
+ }
+ }
+ },
+ "id": "FindFullHashesResponse",
+ "type": "object"
+ },
+ "Checksum": {
+ "description": "The expected state of a client's local database.",
"type": "object",
"properties": {
- "threatType": {
+ "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": {
+ "enum": [
+ "COMPRESSION_TYPE_UNSPECIFIED",
+ "RAW",
+ "RICE"
+ ],
+ "description": "The compression type for the entries in this set.",
"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"
- ],
- "description": "The threat type posed by the list's entries."
+ "Raw, uncompressed data.",
+ "Rice-Golomb encoded data."
+ ]
},
+ "riceIndices": {
+ "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data.",
+ "$ref": "RiceDeltaEncoding"
+ },
+ "rawIndices": {
+ "$ref": "RawIndices",
+ "description": "The raw removal indices for a local list."
+ },
+ "rawHashes": {
+ "$ref": "RawHashes",
+ "description": "The raw SHA256-formatted entries."
+ },
+ "riceHashes": {
+ "$ref": "RiceDeltaEncoding",
+ "description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data."
+ }
+ },
+ "id": "ThreatEntrySet"
+ },
+ "FindFullHashesRequest": {
+ "properties": {
+ "clientStates": {
+ "description": "The current client states for each of the client's local threat lists.",
+ "type": "array",
+ "items": {
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "client": {
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
+ },
+ "threatInfo": {
+ "description": "The lists and hashes to be checked.",
+ "$ref": "ThreatInfo"
+ },
+ "apiClient": {
+ "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation.",
+ "$ref": "ClientInfo"
+ }
+ },
+ "id": "FindFullHashesRequest",
+ "description": "Request to return full hashes matched by the provided hash prefixes.",
+ "type": "object"
+ },
+ "ListUpdateRequest": {
+ "properties": {
"threatEntryType": {
- "enumDescriptions": [
- "Unspecified.",
- "A URL.",
- "An executable program.",
- "An IP range.",
- "Chrome extension.",
- "Filename.",
- "CERT"
- ],
"enum": [
"THREAT_ENTRY_TYPE_UNSPECIFIED",
"URL",
@@ -290,12 +380,24 @@
"FILENAME",
"CERT"
],
- "description": "The entry types contained in the list.",
+ "description": "The types of entries present in the list.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "A URL.",
+ "An executable program.",
+ "An IP range.",
+ "Chrome extension.",
+ "Filename.",
+ "CERT"
+ ]
+ },
+ "state": {
+ "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).",
+ "format": "byte",
"type": "string"
},
"platformType": {
- "description": "The platform type targeted by the list's entries.",
- "type": "string",
"enumDescriptions": [
"Unknown platform.",
"Threat posed to Windows.",
@@ -317,7 +419,432 @@
"ANY_PLATFORM",
"ALL_PLATFORMS",
"CHROME"
+ ],
+ "description": "The type of platform at risk by entries present in the list.",
+ "type": "string"
+ },
+ "threatType": {
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION"
+ ],
+ "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."
]
+ },
+ "constraints": {
+ "description": "The constraints associated with this request.",
+ "$ref": "Constraints"
+ }
+ },
+ "id": "ListUpdateRequest",
+ "description": "A single list update request.",
+ "type": "object"
+ },
+ "FetchThreatListUpdatesRequest": {
+ "properties": {
+ "listUpdateRequests": {
+ "description": "The requested threat list updates.",
+ "type": "array",
+ "items": {
+ "$ref": "ListUpdateRequest"
+ }
+ },
+ "client": {
+ "description": "The client metadata.",
+ "$ref": "ClientInfo"
+ }
+ },
+ "id": "FetchThreatListUpdatesRequest",
+ "description": "Describes a Safe Browsing API update request. Clients can request updates for\nmultiple lists in a single request.\nNOTE: Field index 2 is unused.\nNEXT: 5",
+ "type": "object"
+ },
+ "ListUpdateResponse": {
+ "properties": {
+ "platformType": {
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ],
+ "description": "The platform type for which data is returned.",
+ "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 format of the threats.",
+ "type": "string"
+ },
+ "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": {
+ "$ref": "Checksum",
+ "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later."
+ },
+ "responseType": {
+ "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",
+ "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."
+ ]
+ },
+ "threatType": {
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION"
+ ],
+ "description": "The threat type for which data is returned.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type."
+ ]
+ },
+ "newClientState": {
+ "description": "The new client state, in encrypted format. Opaque to clients.",
+ "format": "byte",
+ "type": "string"
+ },
+ "removals": {
+ "description": "A set of entries to remove from a local threat type's list. In practice,\nthis field is empty or contains exactly one ThreatEntrySet.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatEntrySet"
+ }
+ }
+ },
+ "id": "ListUpdateResponse",
+ "description": "An update to an individual list.",
+ "type": "object"
+ },
+ "Constraints": {
+ "description": "The constraints for this update.",
+ "type": "object",
+ "properties": {
+ "supportedCompressions": {
+ "enumDescriptions": [
+ "Unknown.",
+ "Raw, uncompressed data.",
+ "Rice-Golomb encoded data."
+ ],
+ "description": "The compression types supported by the client.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "COMPRESSION_TYPE_UNSPECIFIED",
+ "RAW",
+ "RICE"
+ ],
+ "type": "string"
+ }
+ },
+ "maxUpdateEntries": {
+ "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "id": "Constraints"
+ },
+ "ThreatMatch": {
+ "properties": {
+ "platformType": {
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ],
+ "description": "The platform type matching this threat.",
+ "type": "string"
+ },
+ "threatEntryType": {
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
+ ],
+ "description": "The threat entry type matching this threat.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "A URL.",
+ "An executable program.",
+ "An IP range.",
+ "Chrome extension.",
+ "Filename.",
+ "CERT"
+ ]
+ },
+ "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"
+ },
+ "threatEntryMetadata": {
+ "description": "Optional metadata associated with this threat.",
+ "$ref": "ThreatEntryMetadata"
+ },
+ "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 matching this threat.",
+ "type": "string"
+ },
+ "threat": {
+ "$ref": "ThreatEntry",
+ "description": "The threat matching this threat."
+ }
+ },
+ "id": "ThreatMatch",
+ "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
+ "type": "object"
+ },
+ "RiceDeltaEncoding": {
+ "properties": {
+ "riceParameter": {
+ "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is zero.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "firstValue": {
+ "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.",
+ "format": "int64",
+ "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"
+ }
+ },
+ "id": "RiceDeltaEncoding",
+ "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
+ "type": "object"
+ },
+ "ListThreatListsResponse": {
+ "type": "object",
+ "properties": {
+ "threatLists": {
+ "description": "The lists available for download by the client.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatListDescriptor"
+ }
+ }
+ },
+ "id": "ListThreatListsResponse"
+ },
+ "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": {
+ "url": {
+ "description": "A URL.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "ThreatEntry"
+ },
+ "FindThreatMatchesResponse": {
+ "properties": {
+ "matches": {
+ "description": "The threat list matches.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatMatch"
+ }
+ }
+ },
+ "id": "FindThreatMatchesResponse",
+ "type": "object"
+ },
+ "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": {
+ "threatEntryType": {
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
+ ],
+ "description": "The entry types contained in the list.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "A URL.",
+ "An executable program.",
+ "An IP range.",
+ "Chrome extension.",
+ "Filename.",
+ "CERT"
+ ]
+ },
+ "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 targeted by the list's entries.",
+ "type": "string"
+ },
+ "threatType": {
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION"
+ ],
+ "description": "The threat type posed by the list's entries.",
+ "type": "string"
}
},
"id": "ThreatListDescriptor"
@@ -326,13 +853,13 @@
"description": "A single metadata entry.",
"type": "object",
"properties": {
- "key": {
- "description": "The metadata entry key. For JSON requests, the key is base64-encoded.",
+ "value": {
+ "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
"format": "byte",
"type": "string"
},
- "value": {
- "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
+ "key": {
+ "description": "The metadata entry key. For JSON requests, the key is base64-encoded.",
"format": "byte",
"type": "string"
}
@@ -340,6 +867,7 @@
"id": "MetadataEntry"
},
"ClientInfo": {
+ "description": "The client metadata associated with Safe Browsing API requests.",
"type": "object",
"properties": {
"clientId": {
@@ -351,36 +879,37 @@
"type": "string"
}
},
- "id": "ClientInfo",
- "description": "The client metadata associated with Safe Browsing API requests."
+ "id": "ClientInfo"
},
"FindThreatMatchesRequest": {
- "id": "FindThreatMatchesRequest",
"description": "Request to check entries against lists.",
"type": "object",
"properties": {
"client": {
- "description": "The client metadata.",
- "$ref": "ClientInfo"
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
},
"threatInfo": {
- "description": "The lists and entries to be checked for matches.",
- "$ref": "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": {
- "threatEntries": {
- "description": "The threat entries to be checked.",
- "type": "array",
- "items": {
- "$ref": "ThreatEntry"
- }
- },
"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": {
@@ -394,18 +923,16 @@
"CERT"
],
"type": "string"
- },
- "enumDescriptions": [
- "Unspecified.",
- "A URL.",
- "An executable program.",
- "An IP range.",
- "Chrome extension.",
- "Filename.",
- "CERT"
- ]
+ }
},
"threatTypes": {
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type."
+ ],
"description": "The threat types to be checked.",
"type": "array",
"items": {
@@ -417,14 +944,7 @@
"POTENTIALLY_HARMFUL_APPLICATION"
],
"type": "string"
- },
- "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.",
@@ -454,6 +974,13 @@
"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"
@@ -488,6 +1015,8 @@
"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.",
@@ -495,546 +1024,17 @@
"type": "string"
},
"prefixSize": {
- "type": "integer",
"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"
- }
- },
- "id": "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"
- },
- "FetchThreatListUpdatesResponse": {
- "type": "object",
- "properties": {
- "listUpdateResponses": {
- "description": "The list updates requested by the clients.",
- "type": "array",
- "items": {
- "$ref": "ListUpdateResponse"
- }
- },
- "minimumWaitDuration": {
- "description": "The minimum duration the client must wait before issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "FetchThreatListUpdatesResponse"
- },
- "Checksum": {
- "description": "The expected state of a client's local database.",
- "type": "object",
- "properties": {
- "sha256": {
- "description": "The SHA256 hash of the client state; that is, of the sorted list of all\nhashes present in the database.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "Checksum"
- },
- "FindFullHashesResponse": {
- "type": "object",
- "properties": {
- "negativeCacheDuration": {
- "type": "string",
- "description": "For requested entities that did not match the threat list, how long to\ncache the response.",
- "format": "google-duration"
- },
- "minimumWaitDuration": {
- "description": "The minimum duration the client must wait before issuing any find hashes\nrequest. If this field is not set, clients can issue a request as soon as\nthey want.",
- "format": "google-duration",
- "type": "string"
- },
- "matches": {
- "description": "The full hashes that matched the requested prefixes.",
- "type": "array",
- "items": {
- "$ref": "ThreatMatch"
- }
- }
- },
- "id": "FindFullHashesResponse"
- },
- "ThreatEntrySet": {
- "id": "ThreatEntrySet",
- "description": "A set of threats that should be added or removed from a client's local\ndatabase.",
- "type": "object",
- "properties": {
- "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"
- },
- "compressionType": {
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ],
- "description": "The compression type for the entries in this set.",
- "type": "string",
- "enumDescriptions": [
- "Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
- ]
- },
- "riceIndices": {
- "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data.",
- "$ref": "RiceDeltaEncoding"
- }
- }
- },
- "FindFullHashesRequest": {
- "description": "Request to return full hashes matched by the provided hash prefixes.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "client": {
- "$ref": "ClientInfo",
- "description": "The client metadata."
- },
- "threatInfo": {
- "$ref": "ThreatInfo",
- "description": "The lists and hashes to be checked."
- }
- },
- "id": "FindFullHashesRequest"
- },
- "ListUpdateRequest": {
- "description": "A single list update request.",
- "type": "object",
- "properties": {
- "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 type of threat posed by entries present in the list.",
- "type": "string"
- },
- "constraints": {
- "description": "The constraints associated with this request.",
- "$ref": "Constraints"
- },
- "threatEntryType": {
- "description": "The types of entries present 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"
- ]
- },
- "state": {
- "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).",
- "format": "byte",
- "type": "string"
- },
- "platformType": {
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ],
- "description": "The type of platform at risk by entries present in the list.",
- "type": "string",
- "enumDescriptions": [
- "Unknown platform.",
- "Threat posed to Windows.",
- "Threat posed to Linux.",
- "Threat posed to Android.",
- "Threat posed to OS X.",
- "Threat posed to iOS.",
- "Threat posed to at least one of the defined platforms.",
- "Threat posed to all defined platforms.",
- "Threat posed to Chrome."
- ]
- }
- },
- "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": {
- "listUpdateRequests": {
- "description": "The requested threat list updates.",
- "type": "array",
- "items": {
- "$ref": "ListUpdateRequest"
- }
- },
- "client": {
- "description": "The client metadata.",
- "$ref": "ClientInfo"
- }
- },
- "id": "FetchThreatListUpdatesRequest"
- },
- "ListUpdateResponse": {
- "description": "An update to an individual list.",
- "type": "object",
- "properties": {
- "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": {
- "type": "array",
- "items": {
- "$ref": "ThreatEntrySet"
- },
- "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."
- },
- "newClientState": {
- "description": "The new client state, in encrypted format. Opaque to clients.",
- "format": "byte",
- "type": "string"
- },
- "platformType": {
- "enumDescriptions": [
- "Unknown platform.",
- "Threat posed to Windows.",
- "Threat posed to Linux.",
- "Threat posed to Android.",
- "Threat posed to OS X.",
- "Threat posed to iOS.",
- "Threat posed to at least one of the defined platforms.",
- "Threat posed to all defined platforms.",
- "Threat posed to Chrome."
- ],
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ],
- "description": "The platform type for which data is returned.",
- "type": "string"
- },
- "threatEntryType": {
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE",
- "CHROME_EXTENSION",
- "FILENAME",
- "CERT"
- ],
- "description": "The format of the threats.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "A URL.",
- "An executable program.",
- "An IP range.",
- "Chrome extension.",
- "Filename.",
- "CERT"
- ]
- },
- "additions": {
- "type": "array",
- "items": {
- "$ref": "ThreatEntrySet"
- },
- "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."
- },
- "checksum": {
- "$ref": "Checksum",
- "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later."
- },
- "responseType": {
- "enumDescriptions": [
- "Unknown.",
- "Partial updates are applied to the client's existing local database.",
- "Full updates replace the client's entire local database. This means\nthat either the client was seriously out-of-date or the client is\nbelieved to be corrupt."
- ],
- "enum": [
- "RESPONSE_TYPE_UNSPECIFIED",
- "PARTIAL_UPDATE",
- "FULL_UPDATE"
- ],
- "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.",
- "type": "string"
- }
- },
- "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": {
- "description": "The compression types supported by the client.",
- "type": "array",
- "items": {
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
- ]
- },
- "maxUpdateEntries": {
- "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.",
"format": "int32",
"type": "integer"
}
},
- "id": "Constraints"
- },
- "ThreatMatch": {
- "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
- "type": "object",
- "properties": {
- "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"
- },
- "threatEntryMetadata": {
- "description": "Optional metadata associated with this threat.",
- "$ref": "ThreatEntryMetadata"
- },
- "threatType": {
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION"
- ],
- "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."
- ]
- },
- "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"
- }
- },
- "id": "ThreatMatch"
- },
- "RiceDeltaEncoding": {
- "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": {
- "type": "integer",
- "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"
- },
- "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",
- "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
- "type": "object"
- },
- "ListThreatListsResponse": {
- "type": "object",
- "properties": {
- "threatLists": {
- "description": "The lists available for download by the client.",
- "type": "array",
- "items": {
- "$ref": "ThreatListDescriptor"
- }
- }
- },
- "id": "ListThreatListsResponse"
- },
- "FindThreatMatchesResponse": {
- "properties": {
- "matches": {
- "description": "The threat list matches.",
- "type": "array",
- "items": {
- "$ref": "ThreatMatch"
- }
- }
- },
- "id": "FindThreatMatchesResponse",
- "type": "object"
- },
- "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"
+ "id": "RawHashes"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "version": "v4",
- "baseUrl": "https://safebrowsing.googleapis.com/"
+ "protocol": "rest"
}
diff --git a/script/v1/script-api.json b/script/v1/script-api.json
index 9d10c0d..2897e64 100644
--- a/script/v1/script-api.json
+++ b/script/v1/script-api.json
@@ -1,8 +1,28 @@
{
+ "ownerDomain": "google.com",
+ "name": "script",
+ "batchPath": "batch",
+ "revision": "20170602",
+ "documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
+ "id": "script:v1",
+ "title": "Google Apps Script Execution API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"scripts": {
"methods": {
"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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "scriptId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://mail.google.com/",
"https://www.google.com/calendar/feeds",
@@ -25,52 +45,30 @@
}
},
"flatPath": "v1/scripts/{scriptId}:run",
- "path": "v1/scripts/{scriptId}:run",
"id": "script.scripts.run",
- "description": "Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script Execution API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.",
- "request": {
- "$ref": "ExecutionRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "scriptId"
- ],
- "httpMethod": "POST"
+ "path": "v1/scripts/{scriptId}:run"
}
}
}
},
"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"
+ "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"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
- "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -80,15 +78,15 @@
"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": [
@@ -96,75 +94,59 @@
"media",
"proto"
],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
"type": "string"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
"type": "string",
- "location": "query",
- "description": "OAuth access token."
+ "location": "query"
},
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "default": "true"
},
"oauth_token": {
+ "type": "string",
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
}
},
"schemas": {
- "Status": {
- "id": "Status",
- "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object.",
- "type": "object",
- "properties": {
- "code": {
- "type": "integer",
- "description": "The status code. For this API, this value will always be 3, corresponding to an INVALID_ARGUMENT error.",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [`google.rpc.Status.details`](google.rpc.Status.details) field, or localized by the client."
- },
- "details": {
- "description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- }
- }
- },
"ExecutionRequest": {
"description": "A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.",
"type": "object",
"properties": {
"sessionState": {
- "description": "For Android add-ons only. An ID that represents the user's current session\nin the Android app for Google Docs or Sheets, included as extra data in the\n[`Intent`](https://developer.android.com/guide/components/intents-filters.html)\nthat launches the add-on. When an Android add-on is run with a session\nstate, it gains the privileges of a\n[bound](https://developers.google.com/apps-script/guides/bound) script —\nthat is, it can access information like the user's current cursor position\n(in Docs) or selected cell (in Sheets). To retrieve the state, call\n`Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`.\nOptional.",
- "type": "string"
+ "type": "string",
+ "description": "For Android add-ons only. An ID that represents the user's current session\nin the Android app for Google Docs or Sheets, included as extra data in the\n[`Intent`](https://developer.android.com/guide/components/intents-filters.html)\nthat launches the add-on. When an Android add-on is run with a session\nstate, it gains the privileges of a\n[bound](https://developers.google.com/apps-script/guides/bound) script —\nthat is, it can access information like the user's current cursor position\n(in Docs) or selected cell (in Sheets). To retrieve the state, call\n`Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`.\nOptional."
},
"function": {
"description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
@@ -185,13 +167,15 @@
"id": "ExecutionRequest"
},
"JoinAsyncRequest": {
+ "description": "A request to retrieve the results from a collection of requests,\nspecified by the operation resource names.",
+ "type": "object",
"properties": {
"names": {
- "description": "List of operation resource names that we want to join,\nas returned from a call to RunAsync.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "List of operation resource names that we want to join,\nas returned from a call to RunAsync."
},
"timeout": {
"description": "Timeout for information retrieval in milliseconds.",
@@ -203,9 +187,7 @@
"type": "string"
}
},
- "id": "JoinAsyncRequest",
- "description": "A request to retrieve the results from a collection of requests,\nspecified by the operation resource names.",
- "type": "object"
+ "id": "JoinAsyncRequest"
},
"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.",
@@ -219,23 +201,28 @@
"id": "ExecutionResponse"
},
"JoinAsyncResponse": {
+ "description": "An object that provides the return value for the JoinAsync method.",
+ "type": "object",
"properties": {
"results": {
+ "description": "The return values for each script function, in a map of operation resource\nnames to the Operation containing the result of the process. The response\nwill contain either an error or the result of the script function.",
+ "type": "object",
"additionalProperties": {
"$ref": "Operation"
- },
- "description": "The return values for each script function, in a map of operation resource\nnames to the Operation containing the result of the process. The response\nwill contain either an error or the result of the script function.",
- "type": "object"
+ }
}
},
- "id": "JoinAsyncResponse",
- "description": "An object that provides the return value for the JoinAsync method.",
- "type": "object"
+ "id": "JoinAsyncResponse"
},
"Operation": {
+ "id": "Operation",
"description": "The response will not arrive until the function finishes executing. The maximum runtime is listed in the guide to [limitations in Apps Script](https://developers.google.com/apps-script/guides/services/quotas#current_limitations).\n\u003cp\u003eIf the script function returns successfully, the `response` field will contain an `ExecutionResponse` object with the function's return value in the object's `result` field.\u003c/p\u003e\n\u003cp\u003eIf the script function (or Apps Script itself) throws an exception, the `error` field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.\u003c/p\u003e\n\u003cp\u003eIf the `run` call itself fails (for example, because of a malformed request or an authorization error), the method will return an HTTP response code in the 4XX range with a different format for the response body. Client libraries will automatically convert a 4XX response into an exception class.\u003c/p\u003e",
"type": "object",
"properties": {
+ "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."
@@ -249,8 +236,8 @@
}
},
"done": {
- "description": "This field is not used.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "This field is not used."
},
"response": {
"type": "object",
@@ -259,21 +246,16 @@
"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."
- },
- "name": {
- "type": "string",
- "description": "This field is not used."
}
- },
- "id": "Operation"
+ }
},
"ScriptStackTraceElement": {
"description": "A stack trace through the script that shows where the execution failed.",
"type": "object",
"properties": {
"function": {
- "description": "The name of the function that failed.",
- "type": "string"
+ "type": "string",
+ "description": "The name of the function that failed."
},
"lineNumber": {
"description": "The line number where the script failed.",
@@ -284,38 +266,71 @@
"id": "ScriptStackTraceElement"
},
"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",
"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"
+ "type": "string",
+ "description": "The error type, for example `TypeError` or `ReferenceError`. If the error\ntype is unavailable, this field is not included."
},
"errorMessage": {
"description": "The error message thrown by Apps Script, usually localized into the user's\nlanguage.",
"type": "string"
+ },
+ "scriptStackTraceElements": {
+ "type": "array",
+ "items": {
+ "$ref": "ScriptStackTraceElement"
+ },
+ "description": "An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first."
}
- },
- "id": "ExecutionError"
+ }
+ },
+ "Status": {
+ "id": "Status",
+ "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error."
+ },
+ "code": {
+ "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"
+ }
+ }
}
},
- "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": "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"
},
@@ -325,45 +340,30 @@
"https://www.googleapis.com/auth/drive": {
"description": "View and manage the files in your Google Drive"
},
- "https://www.googleapis.com/auth/spreadsheets": {
- "description": "View and manage your spreadsheets in Google Drive"
- },
"https://www.googleapis.com/auth/admin.directory.user": {
"description": "View and manage the provisioning of users on your domain"
},
+ "https://www.googleapis.com/auth/admin.directory.group": {
+ "description": "View and manage the provisioning of groups on your domain"
+ },
"https://mail.google.com/": {
"description": "Read, send, delete, and manage your email"
},
- "https://www.googleapis.com/auth/admin.directory.group": {
- "description": "View and manage the provisioning of groups on your domain"
+ "https://www.googleapis.com/auth/spreadsheets": {
+ "description": "View and manage your spreadsheets in Google Drive"
},
"https://www.googleapis.com/auth/forms": {
"description": "View and manage your forms in Google Drive"
},
"https://www.google.com/m8/feeds": {
"description": "Manage your contacts"
- },
- "https://www.googleapis.com/auth/userinfo.email": {
- "description": "View your email address"
- },
- "https://www.google.com/calendar/feeds": {
- "description": "Manage your calendars"
}
}
}
},
- "servicePath": "",
- "description": "Executes Google Apps Script projects.",
"kind": "discovery#restDescription",
+ "description": "Executes Google Apps Script projects.",
+ "servicePath": "",
"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",
- "id": "script:v1",
- "revision": "20170504",
- "title": "Google Apps Script Execution API",
- "ownerName": "Google",
- "discoveryVersion": "v1"
+ "basePath": ""
}
diff --git a/searchconsole/v1/searchconsole-api.json b/searchconsole/v1/searchconsole-api.json
index cdc7abf..70cb875 100644
--- a/searchconsole/v1/searchconsole-api.json
+++ b/searchconsole/v1/searchconsole-api.json
@@ -1,13 +1,18 @@
{
+ "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": "20170508",
- "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/",
"id": "searchconsole:v1",
+ "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/",
+ "revision": "20170603",
"title": "Google Search Console URL Testing Tools API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": "True",
"resources": {
"urlTestingTools": {
@@ -15,10 +20,6 @@
"mobileFriendlyTest": {
"methods": {
"run": {
- "description": "Runs Mobile-Friendly Test for a given URL.",
- "request": {
- "$ref": "RunMobileFriendlyTestRequest"
- },
"httpMethod": "POST",
"parameterOrder": [],
"response": {
@@ -26,8 +27,12 @@
},
"parameters": {},
"flatPath": "v1/urlTestingTools/mobileFriendlyTest:run",
+ "path": "v1/urlTestingTools/mobileFriendlyTest:run",
"id": "searchconsole.urlTestingTools.mobileFriendlyTest.run",
- "path": "v1/urlTestingTools/mobileFriendlyTest:run"
+ "request": {
+ "$ref": "RunMobileFriendlyTestRequest"
+ },
+ "description": "Runs Mobile-Friendly Test for a given URL."
}
}
}
@@ -35,30 +40,15 @@
}
},
"parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "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",
+ "type": "boolean",
"location": "query"
},
"bearer_token": {
@@ -66,6 +56,11 @@
"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",
@@ -74,13 +69,13 @@
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
+ "default": "true",
+ "type": "boolean"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"fields": {
"location": "query",
@@ -106,11 +101,6 @@
"location": "query"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -119,80 +109,28 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
}
},
"schemas": {
- "BlockedResource": {
- "properties": {
- "url": {
- "description": "URL of the blocked resource.",
- "type": "string"
- }
- },
- "id": "BlockedResource",
- "description": "Blocked resource.",
- "type": "object"
- },
- "TestStatus": {
- "description": "Final state of the test, including error details if necessary.",
- "type": "object",
- "properties": {
- "status": {
- "description": "Status of the test.",
- "type": "string",
- "enumDescriptions": [
- "Internal error when running this test. Please try running the test again.",
- "Inspection has completed without errors.",
- "Inspection terminated in an error state. This indicates a problem in\nGoogle's infrastructure, not a user error. Please try again later.",
- "Google can not access the URL because of a user error such as a robots.txt\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected."
- ],
- "enum": [
- "TEST_STATUS_UNSPECIFIED",
- "COMPLETE",
- "INTERNAL_ERROR",
- "PAGE_UNREACHABLE"
- ]
- },
- "details": {
- "description": "Error details if applicable.",
- "type": "string"
- }
- },
- "id": "TestStatus"
- },
- "Image": {
- "description": "Describe image data.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "The mime-type of the image data.",
- "type": "string"
- },
- "data": {
- "description": "Image data in format determined by the mime type. Currently, the format\nwill always be \"image/png\", but this might change in the future.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "Image"
- },
- "RunMobileFriendlyTestRequest": {
- "description": "Mobile-friendly test request.",
- "type": "object",
- "properties": {
- "url": {
- "description": "URL for inspection.",
- "type": "string"
- },
- "requestScreenshot": {
- "description": "Whether or not screenshot is requested. Default is false.",
- "type": "boolean"
- }
- },
- "id": "RunMobileFriendlyTestRequest"
- },
"MobileFriendlyIssue": {
+ "description": "Mobile-friendly issue.",
+ "type": "object",
"properties": {
"rule": {
"enumDescriptions": [
@@ -217,26 +155,26 @@
"type": "string"
}
},
- "id": "MobileFriendlyIssue",
- "description": "Mobile-friendly issue.",
- "type": "object"
+ "id": "MobileFriendlyIssue"
},
"RunMobileFriendlyTestResponse": {
"description": "Mobile-friendly test response, including mobile-friendly issues and resource\nissues.",
"type": "object",
"properties": {
+ "resourceIssues": {
+ "description": "Information about embedded resources issues.",
+ "items": {
+ "$ref": "ResourceIssue"
+ },
+ "type": "array"
+ },
"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": {
+ "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.",
@@ -246,47 +184,109 @@
"MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED",
"MOBILE_FRIENDLY",
"NOT_MOBILE_FRIENDLY"
- ],
- "description": "Test verdict, whether the page is mobile friendly or not.",
- "type": "string"
+ ]
},
"mobileFriendlyIssues": {
"description": "List of mobile-usability issues.",
- "type": "array",
"items": {
"$ref": "MobileFriendlyIssue"
- }
+ },
+ "type": "array"
},
"screenshot": {
- "description": "Screenshot of the requested URL.",
- "$ref": "Image"
+ "$ref": "Image",
+ "description": "Screenshot of the requested URL."
}
},
"id": "RunMobileFriendlyTestResponse"
},
"ResourceIssue": {
+ "description": "Information about a resource with issue.",
+ "type": "object",
"properties": {
"blockedResource": {
"$ref": "BlockedResource",
"description": "Describes a blocked resource issue."
}
},
- "id": "ResourceIssue",
- "description": "Information about a resource with issue.",
- "type": "object"
+ "id": "ResourceIssue"
+ },
+ "BlockedResource": {
+ "description": "Blocked resource.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "URL of the blocked resource.",
+ "type": "string"
+ }
+ },
+ "id": "BlockedResource"
+ },
+ "TestStatus": {
+ "description": "Final state of the test, including error details if necessary.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "enumDescriptions": [
+ "Internal error when running this test. Please try running the test again.",
+ "Inspection has completed without errors.",
+ "Inspection terminated in an error state. This indicates a problem in\nGoogle's infrastructure, not a user error. Please try again later.",
+ "Google can not access the URL because of a user error such as a robots.txt\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected."
+ ],
+ "enum": [
+ "TEST_STATUS_UNSPECIFIED",
+ "COMPLETE",
+ "INTERNAL_ERROR",
+ "PAGE_UNREACHABLE"
+ ],
+ "description": "Status of the test.",
+ "type": "string"
+ },
+ "details": {
+ "description": "Error details if applicable.",
+ "type": "string"
+ }
+ },
+ "id": "TestStatus"
+ },
+ "RunMobileFriendlyTestRequest": {
+ "description": "Mobile-friendly test request.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "URL for inspection.",
+ "type": "string"
+ },
+ "requestScreenshot": {
+ "description": "Whether or not screenshot is requested. Default is false.",
+ "type": "boolean"
+ }
+ },
+ "id": "RunMobileFriendlyTestRequest"
+ },
+ "Image": {
+ "description": "Describe image data.",
+ "type": "object",
+ "properties": {
+ "mimeType": {
+ "description": "The mime-type of the image data.",
+ "type": "string"
+ },
+ "data": {
+ "format": "byte",
+ "description": "Image data in format determined by the mime type. Currently, the format\nwill always be \"image/png\", but this might change in the future.",
+ "type": "string"
+ }
+ },
+ "id": "Image"
}
},
- "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",
- "kind": "discovery#restDescription",
- "description": "Provides tools for running validation tests against single URLs",
- "servicePath": "",
- "rootUrl": "https://searchconsole.googleapis.com/",
- "basePath": ""
+ "canonicalName": "Search Console"
}
diff --git a/servicecontrol/v1/servicecontrol-api.json b/servicecontrol/v1/servicecontrol-api.json
index 4624040..92b730b 100644
--- a/servicecontrol/v1/servicecontrol-api.json
+++ b/servicecontrol/v1/servicecontrol-api.json
@@ -1,291 +1,65 @@
{
- "title": "Google Service Control API",
- "ownerName": "Google",
- "resources": {
- "services": {
- "methods": {
- "startReconciliation": {
- "flatPath": "v1/services/{serviceName}:startReconciliation",
- "id": "servicecontrol.services.startReconciliation",
- "path": "v1/services/{serviceName}:startReconciliation",
- "request": {
- "$ref": "StartReconciliationRequest"
- },
- "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "StartReconciliationResponse"
- },
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ]
- },
- "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": {
- "flatPath": "v1/services/{serviceName}:releaseQuota",
- "path": "v1/services/{serviceName}:releaseQuota",
- "id": "servicecontrol.services.releaseQuota",
- "description": "Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** the client code **must** fail-open if the server returns one\nof the following quota errors:\n- `PROJECT_STATUS_UNAVAILABLE`\n- `SERVICE_STATUS_UNAVAILABLE`\n- `BILLING_STATUS_UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILABLE`\n\nThe server may inject above errors to prohibit any hard dependency\non the quota system.",
- "request": {
- "$ref": "ReleaseQuotaRequest"
- },
- "response": {
- "$ref": "ReleaseQuotaResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "required": true,
- "type": "string"
- }
- }
- },
- "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"
- },
- "response": {
- "$ref": "EndReconciliationResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/services/{serviceName}:endReconciliation",
- "path": "v1/services/{serviceName}:endReconciliation",
- "id": "servicecontrol.services.endReconciliation"
- },
- "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": {
- "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}:report",
- "id": "servicecontrol.services.report",
- "path": "v1/services/{serviceName}:report"
- },
- "allocateQuota": {
- "flatPath": "v1/services/{serviceName}:allocateQuota",
- "path": "v1/services/{serviceName}:allocateQuota",
- "id": "servicecontrol.services.allocateQuota",
- "request": {
- "$ref": "AllocateQuotaRequest"
- },
- "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** the client code **must** fail-open if the server returns one\nof the following quota errors:\n- `PROJECT_STATUS_UNAVAILABLE`\n- `SERVICE_STATUS_UNAVAILABLE`\n- `BILLING_STATUS_UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILABLE`\n\nThe server may inject above errors to prohibit any hard dependency\non the quota system.",
- "response": {
- "$ref": "AllocateQuotaResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "serviceName": {
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ]
- }
- }
- }
- },
- "parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "version": "v1",
- "baseUrl": "https://servicecontrol.googleapis.com/",
- "servicePath": "",
"kind": "discovery#restDescription",
"description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
+ "servicePath": "",
"basePath": "",
- "revision": "20170430",
"id": "servicecontrol:v1",
"documentationLink": "https://cloud.google.com/service-control/",
+ "revision": "20170529",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "AuthorizationInfo": {
+ "description": "Authorization information for the operation.",
+ "type": "object",
+ "properties": {
+ "granted": {
+ "description": "Whether or not authorization for `resource` and `permission`\nwas granted.",
+ "type": "boolean"
+ },
+ "permission": {
+ "description": "The required IAM permission.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googlapis.com/projects/PROJECTID/datasets/DATASETID",
+ "type": "string"
+ }
+ },
+ "id": "AuthorizationInfo"
+ },
+ "StartReconciliationResponse": {
+ "properties": {
+ "operationId": {
+ "description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes.",
+ "type": "string"
+ },
+ "reconciliationErrors": {
+ "description": "Indicates the decision of the reconciliation start.",
+ "type": "array",
+ "items": {
+ "$ref": "QuotaError"
+ }
+ },
+ "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 start of\nreconciliation. The following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
+ "type": "array",
+ "items": {
+ "$ref": "MetricValueSet"
+ }
+ }
+ },
+ "id": "StartReconciliationResponse",
+ "type": "object"
+ },
"QuotaProperties": {
"description": "Represents the properties needed for quota operations.",
"type": "object",
"properties": {
- "limitByIds": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "LimitType IDs that should be used for checking quota. Key in this map\nshould be a valid LimitType string, and the value is the ID to be used. For\nexample, an entry \u003cUSER, 123\u003e will cause all user quota limits to use 123\nas the user ID. See google/api/quota.proto for the definition of LimitType.\nCLIENT_PROJECT: Not supported.\nUSER: Value of this entry will be used for enforcing user-level quota\n limits. If none specified, caller IP passed in the\n servicecontrol.googleapis.com/caller_ip label will be used instead.\n If the server cannot resolve a value for this LimitType, an error\n will be thrown. No validation will be performed on this ID.\nDeprecated: use servicecontrol.googleapis.com/user label to send user ID.",
- "type": "object"
- },
"quotaMode": {
"enumDescriptions": [
"Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation fails and returns\nerror.",
@@ -301,6 +75,13 @@
],
"description": "Quota mode for this operation.",
"type": "string"
+ },
+ "limitByIds": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "LimitType IDs that should be used for checking quota. Key in this map\nshould be a valid LimitType string, and the value is the ID to be used. For\nexample, an entry \u003cUSER, 123\u003e will cause all user quota limits to use 123\nas the user ID. See google/api/quota.proto for the definition of LimitType.\nCLIENT_PROJECT: Not supported.\nUSER: Value of this entry will be used for enforcing user-level quota\n limits. If none specified, caller IP passed in the\n servicecontrol.googleapis.com/caller_ip label will be used instead.\n If the server cannot resolve a value for this LimitType, an error\n will be thrown. No validation will be performed on this ID.\nDeprecated: use servicecontrol.googleapis.com/user label to send user ID.",
+ "type": "object"
}
},
"id": "QuotaProperties"
@@ -343,8 +124,6 @@
"id": "AuthenticationInfo"
},
"AllocateQuotaResponse": {
- "description": "Response message for the AllocateQuota method.",
- "type": "object",
"properties": {
"operationId": {
"description": "The same operation_id value used in the AllocateQuotaRequest. Used for\nlogging and diagnostics purposes.",
@@ -369,25 +148,26 @@
}
}
},
- "id": "AllocateQuotaResponse"
+ "id": "AllocateQuotaResponse",
+ "description": "Response message for the AllocateQuota method.",
+ "type": "object"
},
"ReleaseQuotaRequest": {
- "description": "Request message for the ReleaseQuota method.",
- "type": "object",
"properties": {
+ "releaseOperation": {
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota release."
+ },
"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"
- },
- "releaseOperation": {
- "description": "Operation that describes the quota release.",
- "$ref": "QuotaOperation"
}
},
- "id": "ReleaseQuotaRequest"
+ "id": "ReleaseQuotaRequest",
+ "description": "Request message for the ReleaseQuota method.",
+ "type": "object"
},
"QuotaError": {
- "type": "object",
"properties": {
"subject": {
"description": "Subject to whom this error applies. See the specific enum for more details\non this field. For example, \"clientip:\u003cip address of client\u003e\" or\n\"project:\u003cGoogle developer project id\u003e\".",
@@ -398,19 +178,11 @@
"type": "string"
},
"code": {
- "description": "Error code.",
- "type": "string",
"enumDescriptions": [
"This is never used.",
"Quota allocation failed.\nSame as google.rpc.Code.RESOURCE_EXHAUSTED.",
- "Consumer project has been suspended.",
- "Consumer has not enabled the service.",
- "Consumer cannot access the service because billing is disabled.",
+ "Consumer cannot access the service because the service requires active\nbilling.",
"Consumer's project has been marked as deleted (soft deletion).",
- "Consumer's project number or ID does not represent a valid project.",
- "IP address of the consumer is invalid for the specific consumer\nproject.",
- "Referer address of the consumer request is invalid for the specific\nconsumer project.",
- "Client application of the consumer request is invalid for the\nspecific consumer project.",
"Specified API key is invalid.",
"Specified API Key has expired.",
"Consumer's spatula header is invalid.",
@@ -424,14 +196,8 @@
"enum": [
"UNSPECIFIED",
"RESOURCE_EXHAUSTED",
- "PROJECT_SUSPENDED",
- "SERVICE_NOT_ENABLED",
"BILLING_NOT_ACTIVE",
"PROJECT_DELETED",
- "PROJECT_INVALID",
- "IP_ADDRESS_BLOCKED",
- "REFERER_BLOCKED",
- "CLIENT_APP_BLOCKED",
"API_KEY_INVALID",
"API_KEY_EXPIRED",
"SPATULA_HEADER_INVALID",
@@ -441,28 +207,30 @@
"SERVICE_STATUS_UNAVAILABLE",
"BILLING_STATUS_UNAVAILABLE",
"QUOTA_SYSTEM_UNAVAILABLE"
- ]
+ ],
+ "description": "Error code.",
+ "type": "string"
}
},
- "id": "QuotaError"
+ "id": "QuotaError",
+ "type": "object"
},
"RequestMetadata": {
- "description": "Metadata about the request.",
- "type": "object",
"properties": {
"callerIp": {
"description": "The IP address of the caller.",
"type": "string"
},
"callerSuppliedUserAgent": {
- "description": "The user agent of the caller.\nThis information is not authenticated and should be treated accordingly.\nFor example:\n\n+ `google-api-python-client/1.4.0`:\n The request was made by the Google API client for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n The request was made from the `my-project` App Engine app.",
+ "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.\n\nNOLINT",
"type": "string"
}
},
- "id": "RequestMetadata"
+ "id": "RequestMetadata",
+ "description": "Metadata about the request.",
+ "type": "object"
},
"CheckInfo": {
- "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.",
@@ -472,7 +240,8 @@
}
}
},
- "id": "CheckInfo"
+ "id": "CheckInfo",
+ "type": "object"
},
"ReleaseQuotaResponse": {
"description": "Response message for the ReleaseQuota method.",
@@ -504,13 +273,7 @@
"id": "ReleaseQuotaResponse"
},
"AllocateQuotaRequest": {
- "description": "Request message for the AllocateQuota method.",
- "type": "object",
"properties": {
- "serviceConfigId": {
- "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
- "type": "string"
- },
"allocateOperation": {
"$ref": "QuotaOperation",
"description": "Operation that describes the quota allocation."
@@ -530,13 +293,17 @@
],
"description": "Allocation mode for this operation.\nDeprecated: use QuotaMode inside the QuotaOperation.",
"type": "string"
+ },
+ "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"
+ "id": "AllocateQuotaRequest",
+ "description": "Request message for the AllocateQuota method.",
+ "type": "object"
},
"MetricValueSet": {
- "description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.",
- "type": "object",
"properties": {
"metricName": {
"description": "The metric name defined in the service configuration.",
@@ -550,7 +317,9 @@
}
}
},
- "id": "MetricValueSet"
+ "id": "MetricValueSet",
+ "description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.",
+ "type": "object"
},
"ReportError": {
"description": "Represents the processing error of one `Operation` in the request.",
@@ -571,11 +340,41 @@
"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",
+ "NOT_FOUND",
+ "PERMISSION_DENIED",
+ "RESOURCE_EXHAUSTED",
+ "BUDGET_EXCEEDED",
+ "DENIAL_OF_SERVICE_DETECTED",
+ "LOAD_SHEDDING",
+ "ABUSER_DETECTED",
+ "SERVICE_NOT_ACTIVATED",
+ "VISIBILITY_DENIED",
+ "BILLING_DISABLED",
+ "PROJECT_DELETED",
+ "PROJECT_INVALID",
+ "IP_ADDRESS_BLOCKED",
+ "REFERER_BLOCKED",
+ "CLIENT_APP_BLOCKED",
+ "API_TARGET_BLOCKED",
+ "API_KEY_INVALID",
+ "API_KEY_EXPIRED",
+ "API_KEY_NOT_FOUND",
+ "SPATULA_HEADER_INVALID",
+ "LOAS_ROLE_INVALID",
+ "NO_LOAS_PROJECT",
+ "LOAS_PROJECT_DISABLED",
+ "SECURITY_POLICY_VIOLATED",
+ "NAMESPACE_LOOKUP_UNAVAILABLE",
+ "SERVICE_STATUS_UNAVAILABLE",
+ "BILLING_STATUS_UNAVAILABLE",
+ "QUOTA_CHECK_UNAVAILABLE",
+ "LOAS_PROJECT_LOOKUP_UNAVAILABLE",
+ "CLOUD_RESOURCE_MANAGER_BACKEND_UNAVAILABLE",
+ "SECURITY_POLICY_BACKEND_UNAVAILABLE"
+ ],
"description": "The error code.",
"type": "string",
"enumDescriptions": [
@@ -611,70 +410,47 @@
"The Spanner for looking up LOAS project is unavailable.",
"Cloud Resource Manager backend server is unavailable.",
"Backend server for evaluating security policy is unavailable."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "NOT_FOUND",
- "PERMISSION_DENIED",
- "RESOURCE_EXHAUSTED",
- "BUDGET_EXCEEDED",
- "DENIAL_OF_SERVICE_DETECTED",
- "LOAD_SHEDDING",
- "ABUSER_DETECTED",
- "SERVICE_NOT_ACTIVATED",
- "VISIBILITY_DENIED",
- "BILLING_DISABLED",
- "PROJECT_DELETED",
- "PROJECT_INVALID",
- "IP_ADDRESS_BLOCKED",
- "REFERER_BLOCKED",
- "CLIENT_APP_BLOCKED",
- "API_TARGET_BLOCKED",
- "API_KEY_INVALID",
- "API_KEY_EXPIRED",
- "API_KEY_NOT_FOUND",
- "SPATULA_HEADER_INVALID",
- "LOAS_ROLE_INVALID",
- "NO_LOAS_PROJECT",
- "LOAS_PROJECT_DISABLED",
- "SECURITY_POLICY_VIOLATED",
- "NAMESPACE_LOOKUP_UNAVAILABLE",
- "SERVICE_STATUS_UNAVAILABLE",
- "BILLING_STATUS_UNAVAILABLE",
- "QUOTA_CHECK_UNAVAILABLE",
- "LOAS_PROJECT_LOOKUP_UNAVAILABLE",
- "CLOUD_RESOURCE_MANAGER_BACKEND_UNAVAILABLE",
- "SECURITY_POLICY_BACKEND_UNAVAILABLE"
]
+ },
+ "detail": {
+ "description": "Free-form text providing details on the error cause of the error.",
+ "type": "string"
}
},
"id": "CheckError"
},
"StartReconciliationRequest": {
- "type": "object",
"properties": {
- "serviceConfigId": {
- "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
- "type": "string"
- },
"reconciliationOperation": {
"description": "Operation that describes the quota reconciliation.",
"$ref": "QuotaOperation"
+ },
+ "serviceConfigId": {
+ "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
+ "type": "string"
}
},
- "id": "StartReconciliationRequest"
+ "id": "StartReconciliationRequest",
+ "type": "object"
},
"QuotaInfo": {
"description": "Contains the quota information for a quota check response.",
"type": "object",
"properties": {
+ "limitExceeded": {
+ "description": "Quota Metrics that have exceeded quota limits.\nFor QuotaGroup-based quota, this is QuotaGroup.name\nFor QuotaLimit-based quota, this is QuotaLimit.name\nSee: google.api.Quota\nDeprecated: Use quota_metrics to get per quota group limit exceeded status.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"quotaConsumed": {
- "description": "Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\nDeprecated: Use quota_metrics to get per quota group usage.",
- "type": "object",
"additionalProperties": {
"format": "int32",
"type": "integer"
- }
+ },
+ "description": "Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\nDeprecated: Use quota_metrics to get per quota group usage.",
+ "type": "object"
},
"quotaMetrics": {
"description": "Quota metrics to indicate the usage. Depending on the check request, one or\nmore of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric incremental usage\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_used_count\"\n\n2. For allocation quota, per quota metric total usage will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For both rate quota and allocation quota, the quota limit reached\ncondition will be specified using the following boolean metric:\n \"serviceruntime.googleapis.com/quota/exceeded\"",
@@ -682,13 +458,6 @@
"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"
@@ -697,10 +466,6 @@
"description": "Request message for the Check method.",
"type": "object",
"properties": {
- "serviceConfigId": {
- "description": "Specifies which version of service configuration should be used to process\nthe request.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.",
- "type": "string"
- },
"skipActivationCheck": {
"description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and apply relevant quota.",
"type": "boolean"
@@ -712,6 +477,10 @@
"requestProjectSettings": {
"description": "Requests the project settings to be returned as part of the check response.",
"type": "boolean"
+ },
+ "serviceConfigId": {
+ "description": "Specifies which version of service configuration should be used to process\nthe request.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.",
+ "type": "string"
}
},
"id": "CheckRequest"
@@ -720,28 +489,7 @@
"description": "Represents information regarding a quota operation.",
"type": "object",
"properties": {
- "labels": {
- "description": "Labels describing the operation.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "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": {
- "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 used quota negative, release error\nwill be returned and no quota will be released.",
- "For AllocateQuota request, this mode is supported only for imprecise\nquota limits. In this case, the operation allocates quota for the amount\nspecified in the service configuration or specified using the quota\nmetrics. If the amount is higher than the available quota, request does\nnot fail but all available quota will be allocated.\nFor ReleaseQuota request, this mode is supported for both precise quota\nlimits and imprecise quota limits. In this case, this operation releases\nquota for the amount specified in the service configuration or specified\nusing the quota metrics. If the release can make used quota\nnegative, request does not fail but only the used quota will be\nreleased. After the ReleaseQuota request completes, the used quota\nwill be 0, and never goes to negative.",
- "For AllocateQuota request, only checks if there is enough quota\navailable and does not change the available quota. No lock is placed on\nthe available quota either. Not supported for ReleaseQuota request."
- ],
"enum": [
"UNSPECIFIED",
"NORMAL",
@@ -749,7 +497,13 @@
"CHECK_ONLY"
],
"description": "Quota mode for this operation.",
- "type": "string"
+ "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 used quota negative, release error\nwill be returned and no quota will be released.",
+ "For AllocateQuota request, this mode is supported only for imprecise\nquota limits. In this case, the operation allocates quota for the amount\nspecified in the service configuration or specified using the quota\nmetrics. If the amount is higher than the available quota, request does\nnot fail but all available quota will be allocated.\nFor ReleaseQuota request, this mode is supported for both precise quota\nlimits and imprecise quota limits. In this case, this operation releases\nquota for the amount specified in the service configuration or specified\nusing the quota metrics. If the release can make used quota\nnegative, request does not fail but only the used quota will be\nreleased. After the ReleaseQuota request completes, the used quota\nwill be 0, and never goes to negative.",
+ "For AllocateQuota request, only checks if there is enough quota\navailable and does not change the available quota. No lock is placed on\nthe available quota either. Not supported for ReleaseQuota request."
+ ]
},
"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",
@@ -761,12 +515,26 @@
"items": {
"$ref": "MetricValueSet"
}
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels describing the operation.",
+ "type": "object"
+ },
+ "consumerId": {
+ "description": "Identity of the consumer for whom this quota operation is being performed.\n\nThis can be in one of the following formats:\n project:\u003cproject_id\u003e,\n project_number:\u003cproject_number\u003e,\n api_key:\u003capi_key\u003e.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "Identity of the operation. This 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"
},
"EndReconciliationRequest": {
- "type": "object",
"properties": {
"reconciliationOperation": {
"$ref": "QuotaOperation",
@@ -777,7 +545,8 @@
"type": "string"
}
},
- "id": "EndReconciliationRequest"
+ "id": "EndReconciliationRequest",
+ "type": "object"
},
"ReportInfo": {
"type": "object",
@@ -794,9 +563,35 @@
"id": "ReportInfo"
},
"Operation": {
- "description": "Represents information regarding an operation.",
- "type": "object",
"properties": {
+ "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"
+ }
+ },
+ "userLabels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "User defined labels for the resource that this operation is associated\nwith.",
+ "type": "object"
+ },
+ "metricValueSets": {
+ "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricValueSet"
+ }
+ },
"quotaProperties": {
"$ref": "QuotaProperties",
"description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request."
@@ -824,53 +619,27 @@
"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."
- ],
- "enum": [
- "LOW",
- "HIGH",
- "DEBUG"
]
},
"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": {
- "description": "Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served (e.g. GAE, GCE, GKE).",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "logEntries": {
- "description": "Represents information to be logged.",
- "type": "array",
- "items": {
- "$ref": "LogEntry"
- }
- },
- "userLabels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "User defined labels for the resource that this operation is associated\nwith.",
- "type": "object"
- },
- "metricValueSets": {
- "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.",
- "type": "array",
- "items": {
- "$ref": "MetricValueSet"
- }
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "Represents information regarding an operation.",
+ "type": "object"
},
"ReportResponse": {
"description": "Response message for the Report method.",
@@ -898,8 +667,6 @@
"id": "ReportResponse"
},
"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.",
@@ -925,7 +692,9 @@
"type": "string"
}
},
- "id": "CheckResponse"
+ "id": "CheckResponse",
+ "description": "Response message for the Check method.",
+ "type": "object"
},
"ReportRequest": {
"description": "Request message for the Report method.",
@@ -946,9 +715,20 @@
"id": "ReportRequest"
},
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` 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.",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There 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",
@@ -957,37 +737,12 @@
"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"
},
"LogEntry": {
- "description": "An individual log entry.",
- "type": "object",
"properties": {
- "structPayload": {
- "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "textPayload": {
- "description": "The log entry payload, represented as a Unicode string (UTF-8).",
- "type": "string"
- },
"protoPayload": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -1009,8 +764,6 @@
"type": "object"
},
"severity": {
- "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.",
- "type": "string",
"enumDescriptions": [
"(0) The log entry has no assigned severity level.",
"(100) Debug or trace information.",
@@ -1032,7 +785,9 @@
"CRITICAL",
"ALERT",
"EMERGENCY"
- ]
+ ],
+ "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.",
+ "type": "string"
},
"name": {
"description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
@@ -1041,14 +796,40 @@
"insertId": {
"description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.",
"type": "string"
+ },
+ "structPayload": {
+ "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"
+ "id": "LogEntry",
+ "description": "An individual log entry.",
+ "type": "object"
},
"AuditLog": {
"description": "Common audit log format for Google Cloud Platform API operations.\n\n",
"type": "object",
"properties": {
+ "serviceName": {
+ "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
+ "type": "string"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
+ "type": "object"
+ },
"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"
@@ -1065,75 +846,43 @@
}
},
"request": {
- "description": "The operation request. This may not include all request parameters,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
+ },
+ "description": "The operation request. This may not include all request parameters,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
+ "type": "object"
},
"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"
- }
+ },
+ "description": "Other service-specific data about the request, response, and other\nactivities.",
+ "type": "object"
},
"requestMetadata": {
- "description": "Metadata about the operation.",
- "$ref": "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"
},
+ "authenticationInfo": {
+ "$ref": "AuthenticationInfo",
+ "description": "Authentication information."
+ },
"status": {
"description": "The status of the overall operation.",
"$ref": "Status"
- },
- "authenticationInfo": {
- "description": "Authentication information.",
- "$ref": "AuthenticationInfo"
- },
- "serviceName": {
- "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
- "type": "string"
- },
- "response": {
- "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"
}
},
"id": "AuditLog"
},
"MetricValue": {
- "description": "Represents a single metric value.",
- "type": "object",
"properties": {
- "boolValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
- "endTime": {
- "description": "The end of the time period over which this metric value's measurement\napplies.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.",
- "format": "google-datetime",
- "type": "string"
- },
- "moneyValue": {
- "description": "A money value.",
- "$ref": "Money"
- },
"labels": {
"additionalProperties": {
"type": "string"
@@ -1158,20 +907,53 @@
"distributionValue": {
"description": "A distribution value.",
"$ref": "Distribution"
+ },
+ "boolValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ },
+ "endTime": {
+ "description": "The end of the time period over which this metric value's measurement\napplies.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "moneyValue": {
+ "description": "A money value.",
+ "$ref": "Money"
}
},
- "id": "MetricValue"
+ "id": "MetricValue",
+ "description": "Represents a single metric value.",
+ "type": "object"
},
- "EndReconciliationResponse": {
+ "Money": {
+ "description": "Represents an amount of money with its currency type.",
"type": "object",
"properties": {
- "quotaMetrics": {
- "description": "Metric values as tracked by One Platform before the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith the metrics will be specified using the following metric:\n \"serviceruntime.googleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' use only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
- "type": "array",
- "items": {
- "$ref": "MetricValueSet"
- }
+ "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"
+ },
+ "nanos": {
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Money"
+ },
+ "EndReconciliationResponse": {
+ "properties": {
"operationId": {
"description": "The same operation_id value used in the EndReconciliationRequest. Used for\nlogging and diagnostics purposes.",
"type": "string"
@@ -1186,34 +968,19 @@
"serviceConfigId": {
"description": "ID of the actual config used to process the request.",
"type": "string"
+ },
+ "quotaMetrics": {
+ "description": "Metric values as tracked by One Platform before the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith the metrics will be specified using the following metric:\n \"serviceruntime.googleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' use only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricValueSet"
+ }
}
},
- "id": "EndReconciliationResponse"
- },
- "Money": {
- "description": "Represents an amount of money with its currency type.",
- "type": "object",
- "properties": {
- "nanos": {
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32",
- "type": "integer"
- },
- "units": {
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64",
- "type": "string"
- },
- "currencyCode": {
- "description": "The 3-letter currency code defined in ISO 4217.",
- "type": "string"
- }
- },
- "id": "Money"
+ "id": "EndReconciliationResponse",
+ "type": "object"
},
"ExplicitBuckets": {
- "description": "Describing buckets with arbitrary user-provided width.",
- "type": "object",
"properties": {
"bounds": {
"description": "'bound' is a list of strictly increasing boundaries between\nbuckets. Note that a list of length N-1 defines N buckets because\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th finite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from 1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound' only contains a single element; in\nthat special case the single bound defines the boundary between the\nunderflow and overflow buckets.\n\nbucket number lower bound upper bound\n i == 0 (underflow) -inf bound[i]\n 0 \u003c i \u003c bound_size() bound[i-1] bound[i]\n i == bound_size() (overflow) bound[i-1] +inf",
@@ -1224,12 +991,16 @@
}
}
},
- "id": "ExplicitBuckets"
+ "id": "ExplicitBuckets",
+ "description": "Describing buckets with arbitrary user-provided width.",
+ "type": "object"
},
"Distribution": {
- "description": "Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points",
- "type": "object",
"properties": {
+ "exponentialBuckets": {
+ "description": "Buckets with exponentially growing width.",
+ "$ref": "ExponentialBuckets"
+ },
"minimum": {
"description": "The minimum of the population of values. Ignored if `count` is zero.",
"format": "double",
@@ -1239,16 +1010,16 @@
"description": "Buckets with constant width.",
"$ref": "LinearBuckets"
},
- "mean": {
- "description": "The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.",
- "format": "double",
- "type": "number"
- },
"count": {
"description": "The total number of samples in the distribution. Must be \u003e= 0.",
"format": "int64",
"type": "string"
},
+ "mean": {
+ "description": "The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.",
+ "format": "double",
+ "type": "number"
+ },
"bucketCounts": {
"description": "The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted.",
"type": "array",
@@ -1270,17 +1041,13 @@
"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"
}
},
- "id": "Distribution"
+ "id": "Distribution",
+ "description": "Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points",
+ "type": "object"
},
"ExponentialBuckets": {
- "description": "Describing buckets with exponentially growing width.",
- "type": "object",
"properties": {
"growthFactor": {
"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.",
@@ -1298,54 +1065,9 @@
"type": "integer"
}
},
- "id": "ExponentialBuckets"
- },
- "AuthorizationInfo": {
- "description": "Authorization information for the operation.",
- "type": "object",
- "properties": {
- "resource": {
- "description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googlapis.com/projects/PROJECTID/datasets/DATASETID",
- "type": "string"
- },
- "granted": {
- "description": "Whether or not authorization for `resource` and `permission`\nwas granted.",
- "type": "boolean"
- },
- "permission": {
- "description": "The required IAM permission.",
- "type": "string"
- }
- },
- "id": "AuthorizationInfo"
- },
- "StartReconciliationResponse": {
- "type": "object",
- "properties": {
- "quotaMetrics": {
- "description": "Metric values as tracked by One Platform before the start of\nreconciliation. The following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
- "type": "array",
- "items": {
- "$ref": "MetricValueSet"
- }
- },
- "operationId": {
- "description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes.",
- "type": "string"
- },
- "reconciliationErrors": {
- "description": "Indicates the decision of the reconciliation start.",
- "type": "array",
- "items": {
- "$ref": "QuotaError"
- }
- },
- "serviceConfigId": {
- "description": "ID of the actual config used to process the request.",
- "type": "string"
- }
- },
- "id": "StartReconciliationResponse"
+ "id": "ExponentialBuckets",
+ "description": "Describing buckets with exponentially growing width.",
+ "type": "object"
}
},
"icons": {
@@ -1369,5 +1091,271 @@
"rootUrl": "https://servicecontrol.googleapis.com/",
"ownerDomain": "google.com",
"name": "servicecontrol",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "title": "Google Service Control API",
+ "ownerName": "Google",
+ "resources": {
+ "services": {
+ "methods": {
+ "endReconciliation": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "EndReconciliationResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "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}:endReconciliation",
+ "id": "servicecontrol.services.endReconciliation",
+ "path": "v1/services/{serviceName}:endReconciliation",
+ "description": "Signals the quota controller that service ends the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
+ "request": {
+ "$ref": "EndReconciliationRequest"
+ }
+ },
+ "report": {
+ "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",
+ "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)."
+ },
+ "allocateQuota": {
+ "path": "v1/services/{serviceName}:allocateQuota",
+ "id": "servicecontrol.services.allocateQuota",
+ "request": {
+ "$ref": "AllocateQuotaRequest"
+ },
+ "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** the client code **must** fail-open if the server returns one\nof the following quota errors:\n- `PROJECT_STATUS_UNAVAILABLE`\n- `SERVICE_STATUS_UNAVAILABLE`\n- `BILLING_STATUS_UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILABLE`\n\nThe server may inject above errors to prohibit any hard dependency\non the quota system.",
+ "response": {
+ "$ref": "AllocateQuotaResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:allocateQuota"
+ },
+ "startReconciliation": {
+ "path": "v1/services/{serviceName}:startReconciliation",
+ "id": "servicecontrol.services.startReconciliation",
+ "request": {
+ "$ref": "StartReconciliationRequest"
+ },
+ "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
+ "response": {
+ "$ref": "StartReconciliationResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "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}:startReconciliation"
+ },
+ "check": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "CheckResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:check",
+ "id": "servicecontrol.services.check",
+ "path": "v1/services/{serviceName}:check",
+ "description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the `CheckRequest` has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
+ "request": {
+ "$ref": "CheckRequest"
+ }
+ },
+ "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).\n\n**NOTE:** the client code **must** fail-open if the server returns one\nof the following quota errors:\n- `PROJECT_STATUS_UNAVAILABLE`\n- `SERVICE_STATUS_UNAVAILABLE`\n- `BILLING_STATUS_UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILABLE`\n\nThe server may inject above errors to prohibit any hard dependency\non the quota system.",
+ "request": {
+ "$ref": "ReleaseQuotaRequest"
+ },
+ "response": {
+ "$ref": "ReleaseQuotaResponse"
+ },
+ "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}:releaseQuota",
+ "path": "v1/services/{serviceName}:releaseQuota",
+ "id": "servicecontrol.services.releaseQuota"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://servicecontrol.googleapis.com/"
}
diff --git a/servicecontrol/v1/servicecontrol-gen.go b/servicecontrol/v1/servicecontrol-gen.go
index e45dc3a..16cef55 100644
--- a/servicecontrol/v1/servicecontrol-gen.go
+++ b/servicecontrol/v1/servicecontrol-gen.go
@@ -1389,23 +1389,11 @@
// "UNSPECIFIED" - This is never used.
// "RESOURCE_EXHAUSTED" - Quota allocation failed.
// Same as google.rpc.Code.RESOURCE_EXHAUSTED.
- // "PROJECT_SUSPENDED" - Consumer project has been suspended.
- // "SERVICE_NOT_ENABLED" - Consumer has not enabled the service.
// "BILLING_NOT_ACTIVE" - Consumer cannot access the service because
- // billing is disabled.
+ // the service requires active
+ // billing.
// "PROJECT_DELETED" - Consumer's project has been marked as deleted
// (soft deletion).
- // "PROJECT_INVALID" - Consumer's project number or ID does not
- // represent a valid project.
- // "IP_ADDRESS_BLOCKED" - IP address of the consumer is invalid for
- // the specific consumer
- // project.
- // "REFERER_BLOCKED" - Referer address of the consumer request is
- // invalid for the specific
- // consumer project.
- // "CLIENT_APP_BLOCKED" - Client application of the consumer request
- // is invalid for the
- // specific consumer project.
// "API_KEY_INVALID" - Specified API key is invalid.
// "API_KEY_EXPIRED" - Specified API Key has expired.
// "SPATULA_HEADER_INVALID" - Consumer's spatula header is invalid.
@@ -2015,7 +2003,10 @@
// The request was made by the Google Cloud SDK CLI (gcloud).
// + `AppEngine-Google; (+http://code.google.com/appengine; appid:
// s~my-project`:
- // The request was made from the `my-project` App Engine app.
+ // The request was made from the `my-project` App Engine
+ // app.
+ //
+ // NOLINT
CallerSuppliedUserAgent string `json:"callerSuppliedUserAgent,omitempty"`
// ForceSendFields is a list of field names (e.g. "CallerIp") to
@@ -2163,7 +2154,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -2196,7 +2187,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
diff --git a/servicemanagement/v1/servicemanagement-api.json b/servicemanagement/v1/servicemanagement-api.json
index 4fff134..bb91d52 100644
--- a/servicemanagement/v1/servicemanagement-api.json
+++ b/servicemanagement/v1/servicemanagement-api.json
@@ -1,108 +1,47 @@
{
- "canonicalName": "Service Management",
- "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/service.management.readonly": {
- "description": "View your Google API service configuration"
- },
- "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.",
- "rootUrl": "https://servicemanagement.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "servicemanagement",
- "batchPath": "batch",
- "revision": "20170428",
- "documentationLink": "https://cloud.google.com/service-management/",
- "id": "servicemanagement:v1",
- "title": "Google Service Management API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
"resources": {
- "operations": {
+ "services": {
"methods": {
"list": {
- "path": "v1/operations",
- "id": "servicemanagement.operations.list",
- "description": "Lists service operations that match the specified filter in the request.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
"parameters": {
- "name": {
- "location": "query",
- "description": "Not used.",
- "type": "string"
- },
"pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string"
},
"pageSize": {
"location": "query",
- "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
+ "description": "Requested size of the next page of data.",
"format": "int32",
"type": "integer"
},
- "filter": {
- "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `\u003e=`, `\u003e`, `\u003c=`, and `\u003c`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime\u003e=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime\u003e=\"2017-02-01\")`",
+ "producerProjectId": {
+ "location": "query",
+ "description": "Include services produced by the specified project.",
+ "type": "string"
+ },
+ "consumerId": {
+ "description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:\u003cproject_id\u003e",
"type": "string",
"location": "query"
}
},
- "flatPath": "v1/operations"
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
+ "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": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "servicemanagement.operations.get",
- "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."
- }
- }
- },
- "services": {
- "methods": {
+ "flatPath": "v1/services",
+ "id": "servicemanagement.services.list",
+ "path": "v1/services",
+ "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\"."
+ },
"create": {
"response": {
"$ref": "Operation"
@@ -123,89 +62,63 @@
}
},
"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",
- "id": "servicemanagement.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"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "GenerateConfigReportResponse"
}
},
"get": {
+ "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.",
- "response": {
- "$ref": "ManagedService"
- },
+ "httpMethod": "GET",
"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"
- ],
+ "response": {
+ "$ref": "ManagedService"
+ },
"parameters": {
"serviceName": {
- "required": true,
- "type": "string",
"location": "path",
- "description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`."
- }
- },
- "flatPath": "v1/services/{serviceName}",
- "path": "v1/services/{serviceName}",
- "id": "servicemanagement.services.get"
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "pattern": "^services/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. 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/{servicesId}:testIamPermissions",
- "id": "servicemanagement.services.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions"
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ]
},
- "getConfig": {
- "description": "Gets a service configuration (version) for a managed service.",
+ "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": "Service"
+ "$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
- "serviceName"
+ "resource"
],
- "httpMethod": "GET",
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
@@ -213,57 +126,89 @@
"https://www.googleapis.com/auth/service.management.readonly"
],
"parameters": {
- "view": {
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
"type": "string",
+ "pattern": "^services/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "servicemanagement.services.testIamPermissions"
+ },
+ "getConfig": {
+ "id": "servicemanagement.services.getConfig",
+ "path": "v1/services/{serviceName}/config",
+ "description": "Gets a service configuration (version) for a managed service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Service"
+ },
+ "parameters": {
+ "view": {
"location": "query",
"enum": [
"BASIC",
"FULL"
- ]
+ ],
+ "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "type": "string"
},
"serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "configId": {
+ "type": "string",
+ "location": "query",
+ "description": "The id of the service configuration resource."
+ }
+ },
+ "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"
+ },
+ "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": {
"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": {
- "description": "The id of the service configuration resource.",
- "type": "string",
- "location": "query"
}
},
- "flatPath": "v1/services/{serviceName}/config",
- "path": "v1/services/{serviceName}/config",
- "id": "servicemanagement.services.getConfig"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "serviceName": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
"flatPath": "v1/services/{serviceName}",
- "id": "servicemanagement.services.delete",
"path": "v1/services/{serviceName}",
+ "id": "servicemanagement.services.delete",
"description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e"
},
"enable": {
+ "request": {
+ "$ref": "EnableServiceRequest"
+ },
+ "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: EnableServiceResponse\u003e",
"httpMethod": "POST",
"parameterOrder": [
"serviceName"
@@ -273,10 +218,10 @@
},
"parameters": {
"serviceName": {
- "location": "path",
"description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -285,42 +230,45 @@
],
"flatPath": "v1/services/{serviceName}:enable",
"id": "servicemanagement.services.enable",
- "path": "v1/services/{serviceName}:enable",
- "request": {
- "$ref": "EnableServiceRequest"
- },
- "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: EnableServiceResponse\u003e"
+ "path": "v1/services/{serviceName}:enable"
},
"setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+$",
- "location": "path"
- }
+ "response": {
+ "$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
+ "parameters": {
+ "resource": {
+ "pattern": "^services/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
"flatPath": "v1/services/{servicesId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
"id": "servicemanagement.services.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"request": {
"$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ }
},
"disable": {
+ "flatPath": "v1/services/{serviceName}:disable",
+ "id": "servicemanagement.services.disable",
+ "path": "v1/services/{serviceName}:disable",
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
+ "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
"httpMethod": "POST",
"parameterOrder": [
"serviceName"
@@ -328,10 +276,6 @@
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
"parameters": {
"serviceName": {
"location": "path",
@@ -340,351 +284,78 @@
"type": "string"
}
},
- "flatPath": "v1/services/{serviceName}:disable",
- "id": "servicemanagement.services.disable",
- "path": "v1/services/{serviceName}:disable",
- "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
- "request": {
- "$ref": "DisableServiceRequest"
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ]
},
"getIamPolicy": {
- "id": "servicemanagement.services.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"request": {
"$ref": "GetIamPolicyRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "Policy"
},
- "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 requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{servicesId}:getIamPolicy"
- },
- "undelete": {
- "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation\u003cresponse: UndeleteServiceResponse\u003e",
"parameterOrder": [
- "serviceName"
+ "resource"
],
- "response": {
- "$ref": "Operation"
- },
"httpMethod": "POST",
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{serviceName}:undelete",
- "path": "v1/services/{serviceName}:undelete",
- "id": "servicemanagement.services.undelete"
- },
- "list": {
- "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".",
- "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"
- },
- "pageToken": {
- "location": "query",
- "description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested size of the next page of data.",
- "format": "int32",
- "type": "integer"
- },
- "producerProjectId": {
- "location": "query",
- "description": "Include services produced by the specified project.",
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/service.management",
"https://www.googleapis.com/auth/service.management.readonly"
],
- "flatPath": "v1/services",
- "path": "v1/services",
- "id": "servicemanagement.services.list"
+ "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": "^services/[^/]+$"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "servicemanagement.services.getIamPolicy"
+ },
+ "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"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "serviceName": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`."
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:undelete"
}
},
"resources": {
"configs": {
"methods": {
- "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": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}/configs:submit",
- "path": "v1/services/{serviceName}/configs:submit",
- "id": "servicemanagement.services.configs.submit"
- },
"list": {
- "httpMethod": "GET",
"response": {
"$ref": "ListServiceConfigsResponse"
},
"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"
- },
- "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",
- "id": "servicemanagement.services.configs.list",
- "path": "v1/services/{serviceName}/configs",
- "description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest."
- },
- "get": {
- "flatPath": "v1/services/{serviceName}/configs/{configId}",
- "id": "servicemanagement.services.configs.get",
- "path": "v1/services/{serviceName}/configs/{configId}",
- "description": "Gets a service configuration (version) for a managed service.",
- "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": {
- "description": "The id of the service configuration resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "type": "string"
- }
- }
- },
- "create": {
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "serviceName": {
- "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",
- "path": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.create",
- "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
- "request": {
- "$ref": "Service"
- }
- }
- }
- },
- "consumers": {
- "methods": {
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "pattern": "^services/[^/]+/consumers/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy",
- "id": "servicemanagement.services.consumers.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
- },
- "testIamPermissions": {
- "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/service.management"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+/consumers/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions",
- "id": "servicemanagement.services.consumers.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions"
- },
- "getIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+/consumers/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:getIamPolicy",
- "id": "servicemanagement.services.consumers.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- }
- }
- },
- "rollouts": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListServiceRolloutsResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -694,63 +365,100 @@
],
"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}/rollouts",
- "path": "v1/services/{serviceName}/rollouts",
- "id": "servicemanagement.services.rollouts.list",
- "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest."
- },
- "get": {
- "description": "Gets a service configuration rollout.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Rollout"
- },
- "parameterOrder": [
- "serviceName",
- "rolloutId"
- ],
- "parameters": {
- "serviceName": {
"required": true,
"type": "string",
"location": "path",
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`."
},
- "rolloutId": {
- "location": "path",
- "description": "The id of the rollout resource.",
- "required": true,
- "type": "string"
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The token of the page to retrieve."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The max number of items to include in the response list.",
+ "format": "int32",
+ "type": "integer"
}
},
+ "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": {
+ "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"
],
- "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}",
- "id": "servicemanagement.services.rollouts.get",
- "path": "v1/services/{serviceName}/rollouts/{rolloutId}"
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "configId": {
+ "description": "The id of the service configuration resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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": {
+ "flatPath": "v1/services/{serviceName}/configs",
+ "path": "v1/services/{serviceName}/configs",
+ "id": "servicemanagement.services.configs.create",
+ "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
+ "request": {
+ "$ref": "Service"
+ },
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "serviceName": {
+ "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"
+ }
+ }
+ },
+ "submit": {
"httpMethod": "POST",
"parameterOrder": [
"serviceName"
@@ -770,65 +478,314 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
+ "flatPath": "v1/services/{serviceName}/configs:submit",
+ "id": "servicemanagement.services.configs.submit",
+ "path": "v1/services/{serviceName}/configs:submit",
+ "request": {
+ "$ref": "SubmitConfigSourceRequest"
+ },
+ "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation\u003cresponse: SubmitConfigSourceResponse\u003e"
+ }
+ }
+ },
+ "consumers": {
+ "methods": {
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+/consumers/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field."
+ }
+ },
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy",
+ "id": "servicemanagement.services.consumers.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "testIamPermissions": {
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "servicemanagement.services.consumers.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^services/[^/]+/consumers/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ]
+ },
+ "getIamPolicy": {
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "servicemanagement.services.consumers.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+/consumers/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
+ }
+ },
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:getIamPolicy"
+ }
+ }
+ },
+ "rollouts": {
+ "methods": {
+ "list": {
+ "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
+ "response": {
+ "$ref": "ListServiceRolloutsResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token of the page to retrieve.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The max number of items to include in the response list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
"flatPath": "v1/services/{serviceName}/rollouts",
- "id": "servicemanagement.services.rollouts.create",
"path": "v1/services/{serviceName}/rollouts",
+ "id": "servicemanagement.services.rollouts.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "Rollout"
+ },
+ "parameterOrder": [
+ "serviceName",
+ "rolloutId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "rolloutId": {
+ "description": "The id of the rollout resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}",
+ "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
+ "id": "servicemanagement.services.rollouts.get",
+ "description": "Gets a service configuration rollout."
+ },
+ "create": {
"request": {
"$ref": "Rollout"
},
- "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation\u003cresponse: Rollout\u003e"
+ "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation\u003cresponse: Rollout\u003e",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "serviceName": {
+ "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}/rollouts",
+ "id": "servicemanagement.services.rollouts.create",
+ "path": "v1/services/{serviceName}/rollouts"
}
}
}
}
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "flatPath": "v1/operations",
+ "path": "v1/operations",
+ "id": "servicemanagement.operations.list",
+ "description": "Lists service operations that match the specified filter in the request.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `\u003e=`, `\u003e`, `\u003c=`, and `\u003c`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime\u003e=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime\u003e=\"2017-02-01\")`"
+ },
+ "name": {
+ "description": "Not used.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "servicemanagement.operations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ }
+ }
}
},
"parameters": {
- "pp": {
+ "upload_protocol": {
"location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
+ "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"
- },
- "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"
+ "default": "true",
+ "location": "query"
},
"fields": {
- "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -837,11 +794,16 @@
"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",
@@ -853,6 +815,13 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
"location": "query"
},
"access_token": {
@@ -860,1458 +829,31 @@
"description": "OAuth access token.",
"type": "string"
},
- "key": {
+ "quotaUser": {
"location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "pp": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
}
},
"schemas": {
- "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"
- },
- "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"
- },
- "CloudAuditOptions": {
- "description": "Write a Cloud Audit log",
- "type": "object",
- "properties": {},
- "id": "CloudAuditOptions"
- },
- "ContextRule": {
- "description": "A context rule provides information about the context for an individual API\nelement.",
- "type": "object",
- "properties": {
- "provided": {
- "description": "A list of full type names of provided contexts.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "requested": {
- "description": "A list of full type names of requested contexts.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- }
- },
- "id": "ContextRule"
- },
- "MetricDescriptor": {
- "id": "MetricDescriptor",
- "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
- "type": "object",
- "properties": {
- "metricKind": {
- "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."
- ]
- },
- "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": {
- "type": "string",
- "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'."
- },
- "labels": {
- "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
- "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": {
- "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
- "The value is a `Distribution`.",
- "The value is money."
- ],
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ]
- }
- }
- },
- "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": {
- "description": "Response message for `ListServices` method.",
- "type": "object",
- "properties": {
- "services": {
- "type": "array",
- "items": {
- "$ref": "ManagedService"
- },
- "description": "The returned services will only have the name field set."
- },
- "nextPageToken": {
- "description": "Token that can be passed to `ListServices` to resume a paginated query.",
- "type": "string"
- }
- },
- "id": "ListServicesResponse"
- },
- "Endpoint": {
- "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
- "type": "object",
- "properties": {
- "features": {
- "description": "The list of features enabled on this endpoint.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "apis": {
- "description": "The list of APIs served by 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"
- },
- "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"
- }
- },
- "target": {
- "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
- "type": "string"
- },
- "name": {
- "description": "The canonical name of this endpoint.",
- "type": "string"
- }
- },
- "id": "Endpoint"
- },
- "OAuthRequirements": {
- "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
- "type": "object",
- "properties": {
- "canonicalScopes": {
- "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
- "type": "string"
- }
- },
- "id": "OAuthRequirements"
- },
- "Usage": {
- "description": "Configuration controlling usage of a service.",
- "type": "object",
- "properties": {
- "producerNotificationChannel": {
- "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
- "type": "string"
- },
- "rules": {
- "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "UsageRule"
- }
- },
- "requirements": {
- "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "Usage"
- },
- "GetIamPolicyRequest": {
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {}
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "Context": {
- "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",
- "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"
- },
- "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": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "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."
- },
- "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": {
- "description": "Specifies what kind of log the caller must write",
- "type": "object",
- "properties": {
- "cloudAudit": {
- "description": "Cloud audit options.",
- "$ref": "CloudAuditOptions"
- },
- "counter": {
- "$ref": "CounterOptions",
- "description": "Counter options."
- },
- "dataAccess": {
- "$ref": "DataAccessOptions",
- "description": "Data access options."
- }
- },
- "id": "LogConfig"
- },
- "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"
- },
- "ConfigFile": {
- "description": "Generic specification of a source configuration file",
- "type": "object",
- "properties": {
- "filePath": {
- "description": "The file name of the configuration file (full or relative path).",
- "type": "string"
- },
- "fileType": {
- "enumDescriptions": [
- "Unknown file type.",
- "YAML-specification of service.",
- "OpenAPI specification, serialized in JSON.",
- "OpenAPI specification, serialized in YAML.",
- "FileDescriptorSet, generated by protoc.\n\nTo generate, use protoc with imports and source info included.\nFor an example test.proto file, the following command would put the value\nin a new file named out.pb.\n\n$protoc --include_imports --include_source_info test.proto -o out.pb"
- ],
- "enum": [
- "FILE_TYPE_UNSPECIFIED",
- "SERVICE_CONFIG_YAML",
- "OPEN_API_JSON",
- "OPEN_API_YAML",
- "FILE_DESCRIPTOR_SET_PROTO"
- ],
- "description": "The type of configuration file this represents.",
- "type": "string"
- },
- "fileContents": {
- "description": "The bytes that constitute the file.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ConfigFile"
- },
- "MonitoredResourceDescriptor": {
- "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
- "type": "string"
- },
- "labels": {
- "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "MonitoredResourceDescriptor"
- },
- "CustomErrorRule": {
- "id": "CustomErrorRule",
- "description": "A custom error rule.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "isErrorType": {
- "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
- "type": "boolean"
- }
- }
- },
- "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"
- }
- },
- "id": "MediaDownload"
- },
- "CustomAuthRequirements": {
- "description": "Configuration for a custom authentication provider.",
- "type": "object",
- "properties": {
- "provider": {
- "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
- "type": "string"
- }
- },
- "id": "CustomAuthRequirements"
- },
- "ChangeReport": {
- "description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.",
- "type": "object",
- "properties": {
- "configChanges": {
- "description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction",
- "type": "array",
- "items": {
- "$ref": "ConfigChange"
- }
- }
- },
- "id": "ChangeReport"
- },
- "DisableServiceRequest": {
- "description": "Request message for DisableService method.",
- "type": "object",
- "properties": {
- "consumerId": {
- "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
- "type": "string"
- }
- },
- "id": "DisableServiceRequest"
- },
- "SubmitConfigSourceResponse": {
- "id": "SubmitConfigSourceResponse",
- "description": "Response message for SubmitConfigSource method.",
- "type": "object",
- "properties": {
- "serviceConfig": {
- "$ref": "Service",
- "description": "The generated service configuration."
- }
- }
- },
- "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"
- }
- },
- "id": "MediaUpload"
- },
- "Advice": {
- "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks.",
- "type": "string"
- }
- },
- "id": "Advice"
- },
- "ManagedService": {
- "id": "ManagedService",
- "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
- "type": "object",
- "properties": {
- "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"
- }
- }
- },
- "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"
- },
- "TrafficPercentStrategy": {
- "description": "Strategy that specifies how Google Service Control should select\ndifferent\nversions of service configurations based on traffic percentage.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }",
- "type": "object",
- "properties": {
- "percentages": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
- },
- "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
- "type": "object"
- }
- },
- "id": "TrafficPercentStrategy"
- },
- "Condition": {
- "description": "A condition to be met.",
- "type": "object",
- "properties": {
- "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"
- },
- "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": {
- "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"
- },
- "Documentation": {
- "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
- "type": "object",
- "properties": {
- "summary": {
- "description": "A short summary of what the service does. Can only be provided by\nplain text.",
- "type": "string"
- },
- "documentationRootUrl": {
- "description": "The URL to the root of documentation.",
- "type": "string"
- },
- "rules": {
- "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "DocumentationRule"
- }
- },
- "overview": {
- "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
- "type": "string"
- },
- "pages": {
- "description": "The top level pages for the documentation set.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- }
- },
- "id": "Documentation"
- },
- "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"
- },
- "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`).",
- "type": "array",
- "items": {
- "$ref": "ConfigFile"
- }
- },
- "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"
- }
- },
- "id": "ConfigSource"
- },
- "AuthenticationRule": {
- "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
- "type": "object",
- "properties": {
- "requirements": {
- "description": "Requirements for additional authentication providers.",
- "type": "array",
- "items": {
- "$ref": "AuthRequirement"
- }
- },
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "allowWithoutCredential": {
- "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
- "type": "boolean"
- },
- "oauth": {
- "description": "The requirements for OAuth credentials.",
- "$ref": "OAuthRequirements"
- },
- "customAuth": {
- "$ref": "CustomAuthRequirements",
- "description": "Configuration for custom authentication."
- }
- },
- "id": "AuthenticationRule"
- },
- "BackendRule": {
- "id": "BackendRule",
- "description": "A backend rule provides configuration for an individual API element.",
- "type": "object",
- "properties": {
- "minDeadline": {
- "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
- "format": "double",
- "type": "number"
- },
- "address": {
- "description": "The address of the API backend.",
- "type": "string"
- },
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "deadline": {
- "type": "number",
- "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
- "format": "double"
- }
- }
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object",
- "properties": {
- "version": {
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32",
- "type": "integer"
- },
- "auditConfigs": {
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- },
- "description": "Specifies cloud audit logging configuration for this policy."
- },
- "bindings": {
- "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",
- "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"
- },
- "UndeleteServiceResponse": {
- "type": "object",
- "properties": {
- "service": {
- "description": "Revived service resource.",
- "$ref": "ManagedService"
- }
- },
- "id": "UndeleteServiceResponse",
- "description": "Response message for UndeleteService method."
- },
- "Api": {
- "properties": {
- "syntax": {
- "description": "The source syntax of the service.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ]
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "Source context for the protocol buffer service represented by this\nmessage."
- },
- "version": {
- "description": "A version string for this 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"
- }
- },
- "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"
- }
- },
- "id": "Api",
- "description": "Api is a light-weight descriptor for a protocol buffer service.",
- "type": "object"
- },
- "MetricRule": {
- "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota, billing, and monitoring behaviors to apply to the\nmethod call.\n\nUsed by metric-based quotas only.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "metricCosts": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.",
- "type": "object"
- }
- },
- "id": "MetricRule"
- },
- "DataAccessOptions": {
- "description": "Write a Data Access (Gin) log",
- "type": "object",
- "properties": {},
- "id": "DataAccessOptions"
- },
- "Authentication": {
- "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "AuthenticationRule"
- }
- },
- "providers": {
- "description": "Defines a set of authentication providers that a service supports.",
- "type": "array",
- "items": {
- "$ref": "AuthProvider"
- }
- }
- },
- "id": "Authentication"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "Page": {
- "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
- "type": "object",
- "properties": {
- "content": {
- "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
- "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"
- },
- "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": {
- "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"
- },
- "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"
- },
- "AuthProvider": {
- "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
- "type": "object",
- "properties": {
- "audiences": {
- "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"
- },
- "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": {
- "id": "EnumValue",
- "description": "Enum value definition.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Enum value name.",
- "type": "string"
- },
- "options": {
- "type": "array",
- "items": {
- "$ref": "Option"
- },
- "description": "Protocol buffer options."
- },
- "number": {
- "description": "Enum value number.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "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": {
- "logs": {
- "description": "Defines the logs used by this service.",
- "type": "array",
- "items": {
- "$ref": "LogDescriptor"
- }
- },
- "apis": {
- "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
- "type": "array",
- "items": {
- "$ref": "Api"
- }
- },
- "types": {
- "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
- "type": "array",
- "items": {
- "$ref": "Type"
- }
- },
- "sourceInfo": {
- "$ref": "SourceInfo",
- "description": "Output only. The source information for this configuration if available."
- },
- "http": {
- "$ref": "Http",
- "description": "HTTP configuration."
- },
- "backend": {
- "$ref": "Backend",
- "description": "API backend configuration."
- },
- "systemParameters": {
- "description": "System parameter configuration.",
- "$ref": "SystemParameters"
- },
- "documentation": {
- "description": "Additional API documentation.",
- "$ref": "Documentation"
- },
- "monitoredResources": {
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
- "type": "array",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- }
- },
- "logging": {
- "description": "Logging configuration.",
- "$ref": "Logging"
- },
- "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": {
- "type": "string",
- "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."
- },
- "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"
- },
- "experimental": {
- "$ref": "Experimental",
- "description": "Experimental configuration."
- },
- "control": {
- "description": "Configuration for the service control plane.",
- "$ref": "Control"
- },
- "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`.",
- "format": "uint32",
- "type": "integer"
- },
- "monitoring": {
- "$ref": "Monitoring",
- "description": "Monitoring configuration."
- },
- "systemTypes": {
- "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
- "type": "array",
- "items": {
- "$ref": "Type"
- }
- },
- "producerProjectId": {
- "description": "The 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": {
- "description": "API visibility configuration.",
- "$ref": "Visibility"
- },
- "quota": {
- "$ref": "Quota",
- "description": "Quota configuration."
- },
- "name": {
- "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
- "type": "string"
- },
- "customError": {
- "description": "Custom error configuration.",
- "$ref": "CustomError"
- },
- "title": {
- "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.",
- "type": "array",
- "items": {
- "$ref": "Endpoint"
- }
- }
- },
- "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": {
- "description": "The metadata associated with a long running operation resource.",
- "type": "object",
- "properties": {
- "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"
- },
- "startTime": {
- "description": "The start time of the operation.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "CustomHttpPattern": {
- "properties": {
- "kind": {
- "description": "The name of this custom HTTP verb.",
- "type": "string"
- },
- "path": {
- "description": "The path matched by this custom verb.",
- "type": "string"
- }
- },
- "id": "CustomHttpPattern",
- "description": "A custom pattern is used for defining custom HTTP verb.",
- "type": "object"
- },
- "SystemParameterRule": {
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "parameters": {
- "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
- "type": "array",
- "items": {
- "$ref": "SystemParameter"
- }
- }
- },
- "id": "SystemParameterRule",
- "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
- "type": "object"
- },
- "VisibilityRule": {
- "id": "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"
- }
- }
- },
- "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": {
- "selector": {
- "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "custom": {
- "$ref": "CustomHttpPattern",
- "description": "Custom pattern is used for defining custom verbs."
- },
- "get": {
- "description": "Used for listing and getting information about resources.",
- "type": "string"
- },
- "patch": {
- "description": "Used for updating a resource.",
- "type": "string"
- },
- "put": {
- "description": "Used for updating a resource.",
- "type": "string"
- },
- "delete": {
- "description": "Used for deleting a resource.",
- "type": "string"
- },
- "body": {
- "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
- "type": "string"
- },
- "mediaDownload": {
- "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration.",
- "$ref": "MediaDownload"
- },
- "post": {
- "description": "Used for creating a resource.",
- "type": "string"
- },
- "additionalBindings": {
- "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
- "type": "array",
- "items": {
- "$ref": "HttpRule"
- }
- },
- "responseBody": {
- "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.",
- "type": "string"
- },
- "mediaUpload": {
- "$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."
- }
- },
- "id": "HttpRule"
- },
- "MonitoringDestination": {
- "properties": {
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
- },
- "metrics": {
- "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "MonitoringDestination",
- "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
- "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": {
@@ -2322,31 +864,26 @@
}
}
},
- "id": "Visibility",
- "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate."
+ "id": "Visibility"
+ },
+ "SystemParameters": {
+ "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "SystemParameterRule"
+ }
+ }
+ },
+ "id": "SystemParameters"
},
"ConfigChange": {
+ "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility.",
+ "type": "object",
"properties": {
- "changeType": {
- "description": "The type for this change, either ADDED, REMOVED, or MODIFIED.",
- "type": "string",
- "enumDescriptions": [
- "No value was provided.",
- "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.",
- "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.",
- "The changed object exists in both service configurations, but its value\nis different."
- ],
- "enum": [
- "CHANGE_TYPE_UNSPECIFIED",
- "ADDED",
- "REMOVED",
- "MODIFIED"
- ]
- },
- "element": {
- "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]",
- "type": "string"
- },
"oldValue": {
"description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.",
"type": "string"
@@ -2361,35 +898,55 @@
"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",
- "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility.",
- "type": "object"
+ "id": "ConfigChange"
},
- "SystemParameters": {
+ "Quota": {
"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.",
+ "limits": {
+ "description": "List of `QuotaLimit` definitions for the service.",
"type": "array",
"items": {
- "$ref": "SystemParameterRule"
+ "$ref": "QuotaLimit"
+ }
+ },
+ "metricRules": {
+ "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricRule"
}
}
},
- "id": "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": "Quota",
+ "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
"type": "object"
},
"Rollout": {
- "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.",
"type": "object",
"properties": {
- "deleteServiceStrategy": {
- "$ref": "DeleteServiceStrategy",
- "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly."
- },
"createTime": {
"description": "Creation time of the rollout. Readonly.",
"format": "google-datetime",
@@ -2421,52 +978,34 @@
"description": "The name of the service associated with this Rollout.",
"type": "string"
},
+ "trafficPercentStrategy": {
+ "description": "Google Service Control selects service configurations based on\ntraffic percentage.",
+ "$ref": "TrafficPercentStrategy"
+ },
"createdBy": {
"description": "The user who created the Rollout. Readonly.",
"type": "string"
},
- "trafficPercentStrategy": {
- "$ref": "TrafficPercentStrategy",
- "description": "Google Service Control selects service configurations based on\ntraffic percentage."
- },
"rolloutId": {
- "description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of \u003cdate\u003e\u003crevision number\u003e, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'",
- "type": "string"
- }
- }
- },
- "Quota": {
- "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
- "type": "object",
- "properties": {
- "limits": {
- "description": "List of `QuotaLimit` definitions for the service.\n\nUsed by metric-based quotas only.",
- "type": "array",
- "items": {
- "$ref": "QuotaLimit"
- }
+ "type": "string",
+ "description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of \u003cdate\u003e\u003crevision number\u003e, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'"
},
- "metricRules": {
- "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.\n\nUsed by metric-based quotas only.",
- "type": "array",
- "items": {
- "$ref": "MetricRule"
- }
+ "deleteServiceStrategy": {
+ "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly.",
+ "$ref": "DeleteServiceStrategy"
}
},
- "id": "Quota"
+ "id": "Rollout"
},
"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": "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"
+ "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": {
@@ -2477,62 +1016,62 @@
"type": "object"
}
},
- "id": "GenerateConfigReportRequest"
+ "id": "GenerateConfigReportRequest",
+ "description": "Request message for GenerateConfigReport method.",
+ "type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
"updateMask": {
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"format": "google-fieldmask",
"type": "string"
- },
- "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"
},
+ "DeleteServiceStrategy": {
+ "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
+ "type": "object",
+ "properties": {},
+ "id": "DeleteServiceStrategy"
+ },
"Step": {
+ "description": "Represents the status of one operation step.",
"type": "object",
"properties": {
"status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "DONE",
- "NOT_STARTED",
- "IN_PROGRESS",
- "FAILED",
- "CANCELLED",
- "FAILED_ROLLED_BACK"
- ],
- "description": "The status code.",
- "type": "string",
"enumDescriptions": [
"Unspecifed code.",
"The operation or step has completed without errors.",
"The operation or step has not started yet.",
"The operation or step is in progress.",
"The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.",
- "The operation or step has completed with cancellation.",
- "The operation has completed with errors but rolled back\nsuccessfully if the operation is rollbackable."
- ]
+ "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",
- "description": "Represents the status of one operation step."
- },
- "DeleteServiceStrategy": {
- "type": "object",
- "properties": {},
- "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."
+ "id": "Step"
},
"LoggingDestination": {
"description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
@@ -2553,8 +1092,13 @@
"id": "LoggingDestination"
},
"Option": {
+ "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
"type": "object",
"properties": {
+ "name": {
+ "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
+ "type": "string"
+ },
"value": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -2562,14 +1106,9 @@
},
"description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
"type": "object"
- },
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
- "type": "string"
}
},
- "id": "Option",
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc."
+ "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",
@@ -2593,7 +1132,32 @@
"id": "Logging"
},
"Method": {
+ "description": "Method represents a method of an api.",
+ "type": "object",
"properties": {
+ "syntax": {
+ "description": "The source syntax of this method.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ]
+ },
+ "responseTypeUrl": {
+ "description": "The URL of the output message type.",
+ "type": "string"
+ },
+ "options": {
+ "description": "Any metadata attached to the method.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
"responseStreaming": {
"description": "If true, the response is streamed.",
"type": "boolean"
@@ -2609,39 +1173,16 @@
"requestStreaming": {
"description": "If true, the request is streamed.",
"type": "boolean"
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax of this method.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- },
- "responseTypeUrl": {
- "description": "The URL of the output message type.",
- "type": "string"
- },
- "options": {
- "description": "Any metadata attached to the method.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
}
},
- "id": "Method",
- "description": "Method represents a method of an api.",
- "type": "object"
+ "id": "Method"
},
"QuotaLimit": {
- "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
- "type": "object",
"properties": {
+ "name": {
+ "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
+ "type": "string"
+ },
"freeTier": {
"description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
"format": "int64",
@@ -2652,48 +1193,63 @@
"type": "string"
},
"defaultLimit": {
+ "type": "string",
"description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
- "format": "int64",
+ "format": "int64"
+ },
+ "description": {
+ "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
"type": "string"
},
"displayName": {
- "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
- "type": "string"
+ "type": "string",
+ "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration."
},
"metric": {
"description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.\n\nUsed by metric-based quotas only.",
"type": "string"
},
- "description": {
- "type": "string",
- "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`)."
- },
"values": {
"additionalProperties": {
"format": "int64",
"type": "string"
},
- "description": "Tiered limit values. Also allows for regional or zone overrides for these\nvalues if \"/{region}\" or \"/{zone}\" is specified in the unit field.\n\nCurrently supported tiers from low to high:\nVERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH\n\nTo apply different limit values for users according to their tiers, specify\nthe values for the tiers you want to differentiate. For example:\n{LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}\n\nThe limit value for each tier is optional except for the tier STANDARD.\nThe limit value for an unspecified tier falls to the value of its next\ntier towards tier STANDARD. For the above example, the limit value for tier\nSTANDARD is 500.\n\nTo apply the same limit value for all users, just specify limit value for\ntier STANDARD. For example: {STANDARD:500}.\n\nTo apply a regional overide for a tier, add a map entry with key\n\"\u003cTIER\u003e/\u003cregion\u003e\", where \u003cregion\u003e is a region name. Similarly, for a zone\noverride, add a map entry with key \"\u003cTIER\u003e/{zone}\".\nFurther, a wildcard can be used at the end of a zone name in order to\nspecify zone level overrides. For example:\nLOW: 10, STANDARD: 50, HIGH: 100,\nLOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1: 200,\nLOW/us-central1-*: 10, STANDARD/us-central1-*: 20, HIGH/us-central1-*: 80\n\nThe regional overrides tier set for each region must be the same as\nthe tier set for default limit values. Same rule applies for zone overrides\ntier as well.\n\nUsed by metric-based quotas only.",
+ "description": "Tiered limit values, currently only STANDARD is supported.",
"type": "object"
},
"unit": {
- "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com/service-control)\nsupports the following unit components:\n* One of the time intevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 hours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{organization}\" quota for an organization.\n * \"/{project}\" quota for a project.\n * \"/{folder}\" quota for a folder.\n * \"/{resource}\" quota for a universal resource.\n* Zero or more quota segmentation dimension. Not all combos are valid.\n * \"/{region}\" quota for every region. Not to be used with time intervals.\n * Otherwise the resources granted on the target is not segmented.\n * \"/{zone}\" quota for every zone. Not to be used with time intervals.\n * Otherwise the resources granted on the target is not segmented.\n * \"/{resource}\" quota for a resource associated with a project or org.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n* \"1/min/{user}\" for quota per minute per user.\n* \"1/min/{organization}\" for quota per minute per organization.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUsed by metric-based quotas only.",
+ "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com/service-control)\nsupports the following unit components:\n* One of the time intevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 hours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUsed by metric-based quotas only.",
"type": "string"
},
"maxLimit": {
+ "type": "string",
"description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
+ }
+ },
+ "id": "QuotaLimit",
+ "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
+ "type": "object"
+ },
+ "ListServiceRolloutsResponse": {
+ "description": "Response message for ListServiceRollouts method.",
+ "type": "object",
+ "properties": {
+ "rollouts": {
+ "description": "The list of rollout resources.",
+ "type": "array",
+ "items": {
+ "$ref": "Rollout"
+ }
},
- "name": {
- "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor group-based quota limits, the name must be unique within the quota\ngroup. If a name is not provided, it will be generated from the limit_by\nand duration fields.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
+ "nextPageToken": {
+ "description": "The token of the next page of results.",
"type": "string"
}
},
- "id": "QuotaLimit"
+ "id": "ListServiceRolloutsResponse"
},
"ConfigRef": {
- "description": "Represents a service configuration with its name and id.",
"type": "object",
"properties": {
"name": {
@@ -2701,69 +1257,41 @@
"type": "string"
}
},
- "id": "ConfigRef"
- },
- "ListServiceRolloutsResponse": {
- "description": "Response message for ListServiceRollouts method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The token of the next page of results.",
- "type": "string"
- },
- "rollouts": {
- "description": "The list of rollout resources.",
- "type": "array",
- "items": {
- "$ref": "Rollout"
- }
- }
- },
- "id": "ListServiceRolloutsResponse"
+ "id": "ConfigRef",
+ "description": "Represents a service configuration with its name and 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": {
"name": {
- "type": "string",
- "description": "The fully qualified name of the API which is included."
+ "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",
- "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"
+ "id": "Mixin"
},
"FlowOperationMetadata": {
"description": "The metadata associated with a long running operation resource.",
"type": "object",
"properties": {
- "flowName": {
- "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum.",
- "type": "string"
- },
- "resourceNames": {
- "description": "The full name of the resources that this flow is directly associated with.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"cancelState": {
- "type": "string",
- "enumDescriptions": [
- "Default state, cancellable but not cancelled.",
- "The operation has proceeded past the point of no return and cannot\nbe cancelled.",
- "The operation has been cancelled, work should cease\nand any needed rollback steps executed."
- ],
"enum": [
"RUNNING",
"UNCANCELLABLE",
"CANCELLED"
],
- "description": "The state of the operation with respect to cancellation."
+ "description": "The state of the operation with respect to cancellation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default state, cancellable but not cancelled.",
+ "The operation has proceeded past the point of no return and cannot\nbe cancelled.",
+ "The operation has been cancelled, work should cease\nand any needed rollback steps executed."
+ ]
},
"deadline": {
"description": "Deadline for the flow to complete, to prevent orphaned Operations.\n\nIf the flow has not completed by this time, it may be terminated by\nthe engine, or force-failed by Operation lookup.\n\nNote that this is not a hard deadline after which the Flow will\ndefinitely be failed, rather it is a deadline after which it is reasonable\nto suspect a problem and other parts of the system may kill operation\nto ensure we don't have orphans.\nsee also: go/prevent-orphaned-operations",
@@ -2774,20 +1302,30 @@
"description": "The start time of the operation.",
"format": "google-datetime",
"type": "string"
+ },
+ "flowName": {
+ "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum.",
+ "type": "string"
+ },
+ "resourceNames": {
+ "description": "The full name of the resources that this flow is directly associated with.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "FlowOperationMetadata"
},
"CustomError": {
- "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
"type": "object",
"properties": {
"types": {
- "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'."
},
"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.",
@@ -2797,9 +1335,11 @@
}
}
},
- "id": "CustomError"
+ "id": "CustomError",
+ "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError"
},
"CounterOptions": {
+ "description": "Options for counters",
"type": "object",
"properties": {
"metric": {
@@ -2811,47 +1351,45 @@
"type": "string"
}
},
- "id": "CounterOptions",
- "description": "Options for counters"
+ "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": {
+ "fullyDecodeReservedExpansion": {
+ "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
+ "type": "boolean"
+ },
"rules": {
"description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"type": "array",
"items": {
"$ref": "HttpRule"
}
- },
- "fullyDecodeReservedExpansion": {
- "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
- "type": "boolean"
}
},
"id": "Http"
},
"SourceInfo": {
- "description": "Source information used to create a Service Config",
- "type": "object",
"properties": {
"sourceFiles": {
"description": "All files used during config generation.",
"type": "array",
"items": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "type": "object"
}
}
},
- "id": "SourceInfo"
+ "id": "SourceInfo",
+ "description": "Source information used to create a Service Config",
+ "type": "object"
},
"Control": {
- "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
"type": "object",
"properties": {
"environment": {
@@ -2859,45 +1397,35 @@
"type": "string"
}
},
- "id": "Control"
+ "id": "Control",
+ "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc."
},
"SystemParameter": {
- "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
- "type": "object",
"properties": {
"urlQueryParameter": {
"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"
+ "type": "string",
+ "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive."
},
"name": {
"description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
"type": "string"
}
},
- "id": "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"
},
"Field": {
"description": "A single field of a message type.",
"type": "object",
"properties": {
- "typeUrl": {
- "type": "string",
- "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`."
- },
- "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.",
@@ -2939,22 +1467,28 @@
"TYPE_SFIXED64",
"TYPE_SINT32",
"TYPE_SINT64"
- ],
- "description": "The field type.",
+ ]
+ },
+ "jsonName": {
+ "description": "The field JSON name.",
"type": "string"
},
"options": {
- "description": "The protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
- }
+ },
+ "description": "The protocol buffer options."
},
"oneofIndex": {
"description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
"format": "int32",
"type": "integer"
},
+ "packed": {
+ "description": "Whether to use alternative packed wire representation.",
+ "type": "boolean"
+ },
"cardinality": {
"description": "The field cardinality.",
"type": "string",
@@ -2971,10 +1505,6 @@
"CARDINALITY_REPEATED"
]
},
- "packed": {
- "type": "boolean",
- "description": "Whether to use alternative packed wire representation."
- },
"defaultValue": {
"description": "The string value of the default value of this field. Proto2 syntax only.",
"type": "string"
@@ -2982,6 +1512,15 @@
"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"
@@ -2990,15 +1529,15 @@
"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": {
- "producerDestinations": {
- "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
+ "consumerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
"type": "array",
"items": {
"$ref": "MonitoringDestination"
}
},
- "consumerDestinations": {
- "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
+ "producerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
"type": "array",
"items": {
"$ref": "MonitoringDestination"
@@ -3008,8 +1547,6 @@
"id": "Monitoring"
},
"TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
@@ -3019,34 +1556,18 @@
"type": "string"
}
}
- }
+ },
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method."
},
"Enum": {
"id": "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"
+ "$ref": "SourceContext",
+ "description": "The source context."
},
"syntax": {
"enum": [
@@ -3059,24 +1580,71 @@
"Syntax `proto2`.",
"Syntax `proto3`."
]
+ },
+ "name": {
+ "description": "Enum type name.",
+ "type": "string"
+ },
+ "enumvalue": {
+ "type": "array",
+ "items": {
+ "$ref": "EnumValue"
+ },
+ "description": "Enum value definitions."
+ },
+ "options": {
+ "description": "Protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
}
}
},
+ "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": {
+ "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"
+ },
"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",
- "enumDescriptions": [
- "Warnings and errors",
- "Only errors"
- ]
+ "type": "string"
},
"message": {
"description": "Message describing the error or warning.",
@@ -3089,96 +1657,31 @@
},
"id": "Diagnostic"
},
- "LabelDescriptor": {
- "id": "LabelDescriptor",
- "description": "A description of a label.",
- "type": "object",
- "properties": {
- "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"
- ]
- },
- "key": {
- "description": "The label key.",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "A human-readable description for the label."
- }
- }
- },
"EnableServiceRequest": {
+ "description": "Request message for EnableService method.",
+ "type": "object",
"properties": {
"consumerId": {
"description": "The identity of consumer resource which service enablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
"type": "string"
}
},
- "id": "EnableServiceRequest",
- "description": "Request message for EnableService method.",
- "type": "object"
- },
- "GenerateConfigReportResponse": {
- "description": "Response message for GenerateConfigReport method.",
- "type": "object",
- "properties": {
- "serviceName": {
- "description": "Name of the service this report belongs to.",
- "type": "string"
- },
- "changeReports": {
- "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
- "type": "array",
- "items": {
- "$ref": "ChangeReport"
- }
- },
- "id": {
- "description": "ID of the service configuration this report belongs to.",
- "type": "string"
- },
- "diagnostics": {
- "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
- "type": "array",
- "items": {
- "$ref": "Diagnostic"
- }
- }
- },
- "id": "GenerateConfigReportResponse"
+ "id": "EnableServiceRequest"
},
"Type": {
"description": "A protocol buffer message type.",
"type": "object",
"properties": {
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
"fields": {
- "description": "The list of fields.",
"type": "array",
"items": {
"$ref": "Field"
- }
+ },
+ "description": "The list of fields."
},
"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.",
@@ -3202,10 +1705,46 @@
"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": {
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "ChangeReport"
+ },
+ "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations."
+ },
+ "id": {
+ "description": "ID of the service configuration this report belongs to.",
+ "type": "string"
+ }
+ },
+ "id": "GenerateConfigReportResponse"
+ },
"Experimental": {
"description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
"type": "object",
@@ -3218,33 +1757,27 @@
"id": "Experimental"
},
"ListServiceConfigsResponse": {
+ "description": "Response message for ListServiceConfigs method.",
+ "type": "object",
"properties": {
"serviceConfigs": {
- "description": "The list of service configuration resources.",
"type": "array",
"items": {
"$ref": "Service"
- }
+ },
+ "description": "The list of service configuration resources."
},
"nextPageToken": {
"description": "The token of the next page of results.",
"type": "string"
}
},
- "id": "ListServiceConfigsResponse",
- "description": "Response message for ListServiceConfigs method.",
- "type": "object"
+ "id": "ListServiceConfigsResponse"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
"properties": {
- "exemptedMembers": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"service": {
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type": "string"
@@ -3255,6 +1788,12 @@
"items": {
"$ref": "AuditLogConfig"
}
+ },
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "AuditConfig"
@@ -3263,11 +1802,11 @@
"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",
@@ -3287,6 +1826,1513 @@
}
},
"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": {
+ "id": "AuthorizationConfig",
+ "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
+ "type": "string"
+ }
+ }
+ },
+ "ContextRule": {
+ "description": "A context rule provides information about the context for an individual API\nelement.",
+ "type": "object",
+ "properties": {
+ "requested": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of full type names of requested contexts."
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "provided": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of full type names of provided contexts."
+ }
+ },
+ "id": "ContextRule"
+ },
+ "CloudAuditOptions": {
+ "description": "Write a Cloud Audit log",
+ "type": "object",
+ "properties": {
+ "logName": {
+ "enumDescriptions": [
+ "Default. Should not be used.",
+ "Corresponds to \"cloudaudit.googleapis.com/activity\"",
+ "Corresponds to \"cloudaudit.googleapis.com/data_access\""
+ ],
+ "enum": [
+ "UNSPECIFIED_LOG_NAME",
+ "ADMIN_ACTIVITY",
+ "DATA_ACCESS"
+ ],
+ "description": "The log_name to populate in the Cloud Audit Record.",
+ "type": "string"
+ }
+ },
+ "id": "CloudAuditOptions"
+ },
+ "SourceContext": {
+ "properties": {
+ "fileName": {
+ "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
+ "type": "string"
+ }
+ },
+ "id": "SourceContext",
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "type": "object"
+ },
+ "MetricDescriptor": {
+ "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource name of the metric descriptor. Depending on the\nimplementation, the name typically includes: (1) the parent resource name\nthat defines the scope of the metric type or of its data; and (2) the\nmetric's URL-encoded type, which also appears in the `type` field of this\ndescriptor. For example, following is the resource name of a custom\nmetric within the GCP project `my-project-id`:\n\n \"projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"",
+ "type": "string"
+ },
+ "type": {
+ "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": {
+ "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"
+ },
+ "ListServicesResponse": {
+ "description": "Response message for `ListServices` method.",
+ "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"
+ },
+ "Endpoint": {
+ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The canonical name of this endpoint.",
+ "type": "string"
+ },
+ "target": {
+ "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
+ "type": "string"
+ },
+ "features": {
+ "description": "The list of features enabled on this endpoint.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "apis": {
+ "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration.",
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "UsageRule"
+ },
+ "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
+ },
+ "requirements": {
+ "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Usage",
+ "description": "Configuration controlling usage of a service."
+ },
+ "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": {
+ "id": "Context",
+ "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "ContextRule"
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "LogConfig": {
+ "description": "Specifies what kind of log the caller must write",
+ "type": "object",
+ "properties": {
+ "counter": {
+ "description": "Counter options.",
+ "$ref": "CounterOptions"
+ },
+ "dataAccess": {
+ "$ref": "DataAccessOptions",
+ "description": "Data access options."
+ },
+ "cloudAudit": {
+ "description": "Cloud audit options.",
+ "$ref": "CloudAuditOptions"
+ }
+ },
+ "id": "LogConfig"
+ },
+ "LogDescriptor": {
+ "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": {
+ "type": "string",
+ "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.]."
+ },
+ "description": {
+ "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
+ "type": "string"
+ }
+ },
+ "id": "LogDescriptor",
+ "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"
+ },
+ "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": {
+ "description": "The type of configuration file this represents.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown file type.",
+ "YAML-specification of service.",
+ "OpenAPI specification, serialized in JSON.",
+ "OpenAPI specification, serialized in YAML.",
+ "FileDescriptorSet, generated by protoc.\n\nTo generate, use protoc with imports and source info included.\nFor an example test.proto file, the following command would put the value\nin a new file named out.pb.\n\n$protoc --include_imports --include_source_info test.proto -o out.pb"
+ ],
+ "enum": [
+ "FILE_TYPE_UNSPECIFIED",
+ "SERVICE_CONFIG_YAML",
+ "OPEN_API_JSON",
+ "OPEN_API_YAML",
+ "FILE_DESCRIPTOR_SET_PROTO"
+ ]
+ },
+ "fileContents": {
+ "description": "The bytes that constitute the file.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ConfigFile"
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ }
+ }
+ },
+ "CustomAuthRequirements": {
+ "description": "Configuration for a custom authentication provider.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
+ "type": "string"
+ }
+ },
+ "id": "CustomAuthRequirements"
+ },
+ "MediaDownload": {
+ "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object",
+ "properties": {
+ "maxDirectDownloadSize": {
+ "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
+ },
+ "useDirectDownload": {
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
+ "type": "boolean"
+ },
+ "enabled": {
+ "description": "Whether download is enabled.",
+ "type": "boolean"
+ },
+ "downloadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
+ "type": "string"
+ },
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
+ "type": "boolean"
+ }
+ },
+ "id": "MediaDownload"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "ChangeReport"
+ },
+ "DisableServiceRequest": {
+ "description": "Request message for DisableService method.",
+ "type": "object",
+ "properties": {
+ "consumerId": {
+ "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
+ "type": "string"
+ }
+ },
+ "id": "DisableServiceRequest"
+ },
+ "SubmitConfigSourceResponse": {
+ "description": "Response message for SubmitConfigSource method.",
+ "type": "object",
+ "properties": {
+ "serviceConfig": {
+ "description": "The generated service configuration.",
+ "$ref": "Service"
+ }
+ },
+ "id": "SubmitConfigSourceResponse"
+ },
+ "MediaUpload": {
+ "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object",
+ "properties": {
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
+ "type": "boolean"
+ },
+ "progressNotification": {
+ "description": "Whether to receive a notification for progress changes of media upload.",
+ "type": "boolean"
+ },
+ "enabled": {
+ "description": "Whether upload is enabled.",
+ "type": "boolean"
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
+ },
+ "startNotification": {
+ "description": "Whether to receive a notification on the start of media upload.",
+ "type": "boolean"
+ },
+ "uploadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
+ "type": "string"
+ },
+ "mimeTypes": {
+ "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "maxSize": {
+ "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "MediaUpload"
+ },
+ "Advice": {
+ "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks.",
+ "type": "string"
+ }
+ },
+ "id": "Advice"
+ },
+ "ManagedService": {
+ "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"
+ }
+ },
+ "id": "ManagedService"
+ },
+ "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": {
+ "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
+ "type": "object",
+ "properties": {
+ "providerId": {
+ "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
+ "type": "string"
+ },
+ "audiences": {
+ "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
+ "type": "string"
+ }
+ },
+ "id": "AuthRequirement"
+ },
+ "TrafficPercentStrategy": {
+ "description": "Strategy that specifies how Google Service Control should select\ndifferent\nversions of service configurations based on traffic percentage.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }",
+ "type": "object",
+ "properties": {
+ "percentages": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
+ "type": "object"
+ }
+ },
+ "id": "TrafficPercentStrategy"
+ },
+ "Condition": {
+ "description": "A condition to be met.",
+ "type": "object",
+ "properties": {
+ "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"
+ ]
+ },
+ "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).",
+ "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"
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "id": "Condition"
+ },
+ "Documentation": {
+ "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
+ "type": "object",
+ "properties": {
+ "summary": {
+ "description": "A short summary of what the service does. Can only be provided by\nplain text.",
+ "type": "string"
+ },
+ "documentationRootUrl": {
+ "description": "The URL to the root of documentation.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "DocumentationRule"
+ }
+ },
+ "overview": {
+ "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
+ "type": "string"
+ },
+ "pages": {
+ "description": "The top level pages for the documentation set.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ }
+ },
+ "id": "Documentation"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "logType": {
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ]
+ },
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "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": {
+ "id": {
+ "type": "string",
+ "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."
+ },
+ "files": {
+ "description": "Set of source configuration files that are used to generate a service\nconfiguration (`google.api.Service`).",
+ "type": "array",
+ "items": {
+ "$ref": "ConfigFile"
+ }
+ }
+ },
+ "id": "ConfigSource"
+ },
+ "BackendRule": {
+ "description": "A backend rule provides configuration for an individual API element.",
+ "type": "object",
+ "properties": {
+ "address": {
+ "description": "The address of the API backend.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "deadline": {
+ "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
+ "format": "double",
+ "type": "number"
+ },
+ "minDeadline": {
+ "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "BackendRule"
+ },
+ "AuthenticationRule": {
+ "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
+ "type": "object",
+ "properties": {
+ "requirements": {
+ "description": "Requirements for additional authentication providers.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthRequirement"
+ }
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "allowWithoutCredential": {
+ "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
+ "type": "boolean"
+ },
+ "oauth": {
+ "$ref": "OAuthRequirements",
+ "description": "The requirements for OAuth credentials."
+ },
+ "customAuth": {
+ "description": "Configuration for custom authentication.",
+ "$ref": "CustomAuthRequirements"
+ }
+ },
+ "id": "AuthenticationRule"
+ },
+ "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": {
+ "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",
+ "type": "integer"
+ },
+ "auditConfigs": {
+ "type": "array",
+ "items": {
+ "$ref": "AuditConfig"
+ },
+ "description": "Specifies cloud audit logging configuration for this policy."
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\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"
+ }
+ },
+ "id": "Policy"
+ },
+ "Api": {
+ "description": "Api is a light-weight descriptor for a protocol buffer service.",
+ "type": "object",
+ "properties": {
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of the service.",
+ "type": "string"
+ },
+ "sourceContext": {
+ "description": "Source context for the protocol buffer service represented by this\nmessage.",
+ "$ref": "SourceContext"
+ },
+ "version": {
+ "description": "A version string for this 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"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "Api"
+ },
+ "DataAccessOptions": {
+ "description": "Write a Data Access (Gin) log",
+ "type": "object",
+ "properties": {},
+ "id": "DataAccessOptions"
+ },
+ "MetricRule": {
+ "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
+ "type": "object",
+ "properties": {
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "metricCosts": {
+ "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "id": "MetricRule"
+ },
+ "Authentication": {
+ "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthenticationRule"
+ }
+ },
+ "providers": {
+ "description": "Defines a set of authentication providers that a service supports.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthProvider"
+ }
+ }
+ },
+ "id": "Authentication"
+ },
+ "Operation": {
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "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."
+ }
+ }
+ },
+ "Page": {
+ "id": "Page",
+ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
+ "type": "object",
+ "properties": {
+ "subpages": {
+ "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "name": {
+ "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
+ "type": "string"
+ },
+ "content": {
+ "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
+ "type": "string"
+ }
+ }
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There 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"
+ }
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "id": "Status"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding"
+ },
+ "AuthProvider": {
+ "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
+ "type": "object",
+ "properties": {
+ "audiences": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "title": {
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "Endpoint"
+ }
+ },
+ "logs": {
+ "description": "Defines the logs used by this service.",
+ "type": "array",
+ "items": {
+ "$ref": "LogDescriptor"
+ }
+ },
+ "apis": {
+ "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
+ "type": "array",
+ "items": {
+ "$ref": "Api"
+ }
+ },
+ "types": {
+ "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
+ "type": "array",
+ "items": {
+ "$ref": "Type"
+ }
+ },
+ "sourceInfo": {
+ "$ref": "SourceInfo",
+ "description": "Output only. The source information for this configuration if available."
+ },
+ "http": {
+ "$ref": "Http",
+ "description": "HTTP configuration."
+ },
+ "backend": {
+ "description": "API backend configuration.",
+ "$ref": "Backend"
+ },
+ "systemParameters": {
+ "$ref": "SystemParameters",
+ "description": "System parameter configuration."
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ }
+ },
+ "logging": {
+ "$ref": "Logging",
+ "description": "Logging configuration."
+ },
+ "enums": {
+ "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
+ "type": "array",
+ "items": {
+ "$ref": "Enum"
+ }
+ },
+ "context": {
+ "$ref": "Context",
+ "description": "Context configuration."
+ },
+ "id": {
+ "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
+ "type": "string"
+ },
+ "usage": {
+ "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"
+ },
+ "control": {
+ "description": "Configuration for the service control plane.",
+ "$ref": "Control"
+ },
+ "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`.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "monitoring": {
+ "description": "Monitoring configuration.",
+ "$ref": "Monitoring"
+ },
+ "systemTypes": {
+ "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
+ "type": "array",
+ "items": {
+ "$ref": "Type"
+ }
+ },
+ "producerProjectId": {
+ "description": "The 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."
+ },
+ "quota": {
+ "description": "Quota configuration.",
+ "$ref": "Quota"
+ },
+ "name": {
+ "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
+ "type": "string"
+ },
+ "customError": {
+ "$ref": "CustomError",
+ "description": "Custom error configuration."
+ }
+ },
+ "id": "Service"
+ },
+ "EnumValue": {
+ "description": "Enum value definition.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "description": "Enum value number.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "description": "Enum value name."
+ },
+ "options": {
+ "description": "Protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ }
+ },
+ "id": "EnumValue"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "CustomHttpPattern": {
+ "description": "A custom pattern is used for defining custom HTTP verb.",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "The name of this custom HTTP verb.",
+ "type": "string"
+ },
+ "path": {
+ "description": "The path matched by this custom verb.",
+ "type": "string"
+ }
+ },
+ "id": "CustomHttpPattern"
+ },
+ "OperationMetadata": {
+ "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": {
+ "type": "integer",
+ "description": "Percentage of completion of this operation, ranging from 0 to 100.",
+ "format": "int32"
+ }
+ },
+ "id": "OperationMetadata",
+ "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",
+ "properties": {
+ "parameters": {
+ "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
+ "type": "array",
+ "items": {
+ "$ref": "SystemParameter"
+ }
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "SystemParameterRule"
+ },
+ "VisibilityRule": {
+ "type": "object",
+ "properties": {
+ "restriction": {
+ "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "VisibilityRule",
+ "description": "A visibility rule provides visibility configuration for an individual API\nelement."
+ },
+ "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 service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it 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": {
+ "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"
+ },
+ "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": {
+ "$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."
+ },
+ "restMethodName": {
+ "description": "Optional. The rest method name is by default derived from the URL\npattern. If specified, this field overrides the default method name.\nExample:\n\n rpc CreateResource(CreateResourceRequest)\n returns (CreateResourceResponse) {\n option (google.api.http) = {\n post: \"/v1/resources\",\n body: \"resource\",\n rest_method_name: \"insert\"\n };\n }\n\nThis method has the automatically derived rest method name \"create\", but\n for backwards compatability with apiary, it is specified as insert.",
+ "type": "string"
+ },
+ "additionalBindings": {
+ "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
+ "type": "array",
+ "items": {
+ "$ref": "HttpRule"
+ }
+ },
+ "responseBody": {
+ "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.",
+ "type": "string"
+ },
+ "restCollection": {
+ "description": "Optional. The REST collection name is by default derived from the URL\npattern. If specified, this field overrides the default collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggregatedListRequest)\n returns (AddressesAggregatedListResponse) {\n option (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/addresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\nThis method has the automatically derived collection name\n\"projects.aggregated\". Because, semantically, this rpc is actually an\noperation on the \"projects.addresses\" collection, the `rest_collection`\nfield is configured to override the derived collection name.",
+ "type": "string"
+ }
+ }
+ },
+ "MonitoringDestination": {
+ "id": "MonitoringDestination",
+ "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
+ "type": "object",
+ "properties": {
+ "metrics": {
+ "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
+ "type": "string"
+ }
+ }
}
},
"icons": {
@@ -3295,5 +3341,38 @@
},
"protocol": "rest",
"version": "v1",
- "baseUrl": "https://servicemanagement.googleapis.com/"
+ "baseUrl": "https://servicemanagement.googleapis.com/",
+ "canonicalName": "Service Management",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/service.management": {
+ "description": "Manage your Google API service configuration"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/service.management.readonly": {
+ "description": "View your Google API service configuration"
+ }
+ }
+ }
+ },
+ "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": "",
+ "ownerDomain": "google.com",
+ "name": "servicemanagement",
+ "batchPath": "batch",
+ "revision": "20170526",
+ "documentationLink": "https://cloud.google.com/service-management/",
+ "id": "servicemanagement:v1",
+ "title": "Google Service Management API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/servicemanagement/v1/servicemanagement-gen.go b/servicemanagement/v1/servicemanagement-gen.go
index 7bd3c65..335ae95 100644
--- a/servicemanagement/v1/servicemanagement-gen.go
+++ b/servicemanagement/v1/servicemanagement-gen.go
@@ -834,6 +834,7 @@
// 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
@@ -913,6 +914,37 @@
// CloudAuditOptions: Write a Cloud Audit log
type CloudAuditOptions struct {
+ // LogName: The log_name to populate in the Cloud Audit Record.
+ //
+ // Possible values:
+ // "UNSPECIFIED_LOG_NAME" - Default. Should not be used.
+ // "ADMIN_ACTIVITY" - Corresponds to
+ // "cloudaudit.googleapis.com/activity"
+ // "DATA_ACCESS" - Corresponds to
+ // "cloudaudit.googleapis.com/data_access"
+ LogName string `json:"logName,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "LogName") 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. "LogName") 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 *CloudAuditOptions) MarshalJSON() ([]byte, error) {
+ type noMethod CloudAuditOptions
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Condition: A condition to be met.
@@ -936,7 +968,6 @@
// 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
@@ -1869,6 +1900,10 @@
AllowCors bool `json:"allowCors,omitempty"`
// Apis: The list of APIs served by this endpoint.
+ //
+ // If no APIs are specified this translates to "all APIs" exported by
+ // the
+ // service, as defined in the top-level service configuration.
Apis []string `json:"apis,omitempty"`
// Features: The list of features enabled on this endpoint.
@@ -2384,6 +2419,11 @@
// message:
//
//
+// service Messaging {
+// rpc GetMessage(GetMessageRequest) returns (Message) {
+// option (google.api.http).get = "/v1/messages/{message_id}";
+// }
+// }
// message GetMessageRequest {
// message SubMessage {
// string subfield = 1;
@@ -2630,6 +2670,49 @@
// at the top-level of response message type.
ResponseBody string `json:"responseBody,omitempty"`
+ // RestCollection: Optional. The REST collection name is by default
+ // derived from the URL
+ // pattern. If specified, this field overrides the default collection
+ // name.
+ // Example:
+ //
+ // rpc AddressesAggregatedList(AddressesAggregatedListRequest)
+ // returns (AddressesAggregatedListResponse) {
+ // option (google.api.http) = {
+ // get: "/v1/projects/{project_id}/aggregated/addresses"
+ // rest_collection: "projects.addresses"
+ // };
+ // }
+ //
+ // This method has the automatically derived collection
+ // name
+ // "projects.aggregated". Because, semantically, this rpc is actually
+ // an
+ // operation on the "projects.addresses" collection, the
+ // `rest_collection`
+ // field is configured to override the derived collection name.
+ RestCollection string `json:"restCollection,omitempty"`
+
+ // RestMethodName: Optional. The rest method name is by default derived
+ // from the URL
+ // pattern. If specified, this field overrides the default method
+ // name.
+ // Example:
+ //
+ // rpc CreateResource(CreateResourceRequest)
+ // returns (CreateResourceResponse) {
+ // option (google.api.http) = {
+ // post: "/v1/resources",
+ // body: "resource",
+ // rest_method_name: "insert"
+ // };
+ // }
+ //
+ // This method has the automatically derived rest method name "create",
+ // but
+ // for backwards compatability with apiary, it is specified as insert.
+ RestMethodName string `json:"restMethodName,omitempty"`
+
// Selector: Selects methods to which this rule applies.
//
// Refer to selector for syntax details.
@@ -3090,30 +3173,51 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// MediaDownload: Use this only for Scotty Requests. Do not use this for
-// media support using
+// MediaDownload: Defines the Media configuration for a service in case
+// of a download.
+// Use this only for Scotty Requests. Do not use this for media support
+// using
// Bytestream, add instead [][google.bytestream.RestByteStream] as an
// API to
// your configuration for Bytestream methods.
type MediaDownload struct {
- // DownloadService: DO NOT USE THIS FIELD UNTIL THIS WARNING IS
- // REMOVED.
+ // CompleteNotification: A boolean that determines whether a
+ // notification for the completion of a
+ // download should be sent to the backend.
+ CompleteNotification bool `json:"completeNotification,omitempty"`
+
+ // DownloadService: DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING
+ // IS REMOVED.
//
// Specify name of the download service if one is used for download.
DownloadService string `json:"downloadService,omitempty"`
+ // Dropzone: Name of the Scotty dropzone to use for the current API.
+ Dropzone string `json:"dropzone,omitempty"`
+
// Enabled: Whether download is enabled.
Enabled bool `json:"enabled,omitempty"`
- // ForceSendFields is a list of field names (e.g. "DownloadService") 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.
+ // MaxDirectDownloadSize: Optional maximum acceptable size for direct
+ // download.
+ // The size is specified in bytes.
+ MaxDirectDownloadSize int64 `json:"maxDirectDownloadSize,omitempty,string"`
+
+ // UseDirectDownload: A boolean that determines if direct download from
+ // ESF should be used for
+ // download of this media.
+ UseDirectDownload bool `json:"useDirectDownload,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "CompleteNotification") 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. "DownloadService") to
+ // NullFields is a list of field names (e.g. "CompleteNotification") 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
@@ -3129,35 +3233,66 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// MediaUpload: Use this only for Scotty Requests. Do not use this for
-// media support using
+// MediaUpload: Defines the Media configuration for a service in case of
+// an upload.
+// Use this only for Scotty Requests. Do not use this for media support
+// using
// Bytestream, add instead [][google.bytestream.RestByteStream] as an
// API to
// your configuration for Bytestream methods.
type MediaUpload struct {
+ // CompleteNotification: A boolean that determines whether a
+ // notification for the completion of an
+ // upload should be sent to the backend. These notifications will not be
+ // seen
+ // by the client and will not consume quota.
+ CompleteNotification bool `json:"completeNotification,omitempty"`
+
+ // Dropzone: Name of the Scotty dropzone to use for the current API.
+ Dropzone string `json:"dropzone,omitempty"`
+
// Enabled: Whether upload is enabled.
Enabled bool `json:"enabled,omitempty"`
- // UploadService: DO NOT USE THIS FIELD UNTIL THIS WARNING IS
- // REMOVED.
+ // MaxSize: Optional maximum acceptable size for an upload.
+ // The size is specified in bytes.
+ MaxSize int64 `json:"maxSize,omitempty,string"`
+
+ // MimeTypes: An array of mimetype patterns. Esf will only accept
+ // uploads that match one
+ // of the given patterns.
+ MimeTypes []string `json:"mimeTypes,omitempty"`
+
+ // ProgressNotification: Whether to receive a notification for progress
+ // changes of media upload.
+ ProgressNotification bool `json:"progressNotification,omitempty"`
+
+ // StartNotification: Whether to receive a notification on the start of
+ // media upload.
+ StartNotification bool `json:"startNotification,omitempty"`
+
+ // UploadService: DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING
+ // IS REMOVED.
//
// Specify name of the upload service if one is used for upload.
UploadService string `json:"uploadService,omitempty"`
- // ForceSendFields is a list of field names (e.g. "Enabled") 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 is a list of field names (e.g.
+ // "CompleteNotification") 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. "Enabled") 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. "CompleteNotification") 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:"-"`
}
@@ -3400,11 +3535,7 @@
// MetricRule: Bind API methods to metrics. Binding a method to a metric
// causes that
-// metric's configured quota, billing, and monitoring behaviors to apply
-// to the
-// method call.
-//
-// Used by metric-based quotas only.
+// metric's configured quota behaviors to apply to the method call.
type MetricRule struct {
// MetricCosts: Metrics to update when the selected methods are called,
// and the associated
@@ -4217,15 +4348,11 @@
// value_type: INT64
type Quota struct {
// Limits: List of `QuotaLimit` definitions for the service.
- //
- // Used by metric-based quotas only.
Limits []*QuotaLimit `json:"limits,omitempty"`
// MetricRules: List of `MetricRule` definitions, each one mapping a
// selected method to one
// or more metrics.
- //
- // Used by metric-based quotas only.
MetricRules []*MetricRule `json:"metricRules,omitempty"`
// ForceSendFields is a list of field names (e.g. "Limits") to
@@ -4345,12 +4472,6 @@
// when
// overriding the default limit on per-consumer basis.
//
- // For group-based quota limits, the name must be unique within the
- // quota
- // group. If a name is not provided, it will be generated from the
- // limit_by
- // and duration fields.
- //
// For metric-based quota limits, the name must be provided, and it must
// be
// unique within the service. The name can only include
@@ -4385,26 +4506,10 @@
// * Otherwise the quota won't be reset by time, such as storage
// limit.
// * One and only one of the granted containers:
- // * "/{organization}" quota for an organization.
- // * "/{project}" quota for a project.
- // * "/{folder}" quota for a folder.
- // * "/{resource}" quota for a universal resource.
- // * Zero or more quota segmentation dimension. Not all combos are
- // valid.
- // * "/{region}" quota for every region. Not to be used with time
- // intervals.
- // * Otherwise the resources granted on the target is not segmented.
- // * "/{zone}" quota for every zone. Not to be used with time
- // intervals.
- // * Otherwise the resources granted on the target is not segmented.
- // * "/{resource}" quota for a resource associated with a project or
- // org.
+ // * "/{project}" quota for a project
//
// Here are some examples:
// * "1/min/{project}" for quota per minute per project.
- // * "1/min/{user}" for quota per minute per user.
- // * "1/min/{organization}" for quota per minute per
- // organization.
//
// Note: the order of unit components is insignificant.
// The "1" at the beginning is required to follow the metric unit
@@ -4413,53 +4518,7 @@
// Used by metric-based quotas only.
Unit string `json:"unit,omitempty"`
- // Values: Tiered limit values. Also allows for regional or zone
- // overrides for these
- // values if "/{region}" or "/{zone}" is specified in the unit
- // field.
- //
- // Currently supported tiers from low to high:
- // VERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH
- //
- // To apply different limit values for users according to their tiers,
- // specify
- // the values for the tiers you want to differentiate. For
- // example:
- // {LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}
- //
- // The limit value for each tier is optional except for the tier
- // STANDARD.
- // The limit value for an unspecified tier falls to the value of its
- // next
- // tier towards tier STANDARD. For the above example, the limit value
- // for tier
- // STANDARD is 500.
- //
- // To apply the same limit value for all users, just specify limit value
- // for
- // tier STANDARD. For example: {STANDARD:500}.
- //
- // To apply a regional overide for a tier, add a map entry with
- // key
- // "<TIER>/<region>", where <region> is a region name. Similarly, for a
- // zone
- // override, add a map entry with key "<TIER>/{zone}".
- // Further, a wildcard can be used at the end of a zone name in order
- // to
- // specify zone level overrides. For example:
- // LOW: 10, STANDARD: 50, HIGH: 100,
- // LOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1:
- // 200,
- // LOW/us-central1-*: 10, STANDARD/us-central1-*: 20,
- // HIGH/us-central1-*: 80
- //
- // The regional overrides tier set for each region must be the same
- // as
- // the tier set for default limit values. Same rule applies for zone
- // overrides
- // tier as well.
- //
- // Used by metric-based quotas only.
+ // Values: Tiered limit values, currently only STANDARD is supported.
Values map[string]string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "DefaultLimit") to
@@ -4971,7 +5030,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -5004,7 +5063,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
@@ -5079,9 +5138,6 @@
// rollbackable, the rollback completed with errors too.
// "CANCELLED" - The operation or step has completed with
// cancellation.
- // "FAILED_ROLLED_BACK" - The operation has completed with errors but
- // rolled back
- // successfully if the operation is rollbackable.
Status string `json:"status,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
@@ -7264,7 +7320,9 @@
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/service.management"
+ // "https://www.googleapis.com/auth/cloud-platform.read-only",
+ // "https://www.googleapis.com/auth/service.management",
+ // "https://www.googleapis.com/auth/service.management.readonly"
// ]
// }
@@ -7764,7 +7822,9 @@
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/service.management"
+ // "https://www.googleapis.com/auth/cloud-platform.read-only",
+ // "https://www.googleapis.com/auth/service.management",
+ // "https://www.googleapis.com/auth/service.management.readonly"
// ]
// }
@@ -8684,7 +8744,9 @@
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/service.management"
+ // "https://www.googleapis.com/auth/cloud-platform.read-only",
+ // "https://www.googleapis.com/auth/service.management",
+ // "https://www.googleapis.com/auth/service.management.readonly"
// ]
// }
@@ -8968,7 +9030,9 @@
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
- // "https://www.googleapis.com/auth/service.management"
+ // "https://www.googleapis.com/auth/cloud-platform.read-only",
+ // "https://www.googleapis.com/auth/service.management",
+ // "https://www.googleapis.com/auth/service.management.readonly"
// ]
// }
@@ -9294,6 +9358,22 @@
return c
}
+// Filter sets the optional parameter "filter": Use `filter` to return
+// subset of rollouts.
+// The following filters are supported:
+// -- To limit the results to only those in
+// [status](google.api.servicemanagement.v1.RolloutStatus)
+// 'SUCCESS',
+// use filter='status=SUCCESS'
+// -- To limit the results to those in
+// [status](google.api.servicemanagement.v1.RolloutStatus)
+// 'CANCELLED'
+// or 'FAILED', use filter='status=CANCELLED OR status=FAILED'
+func (c *ServicesRolloutsListCall) Filter(filter string) *ServicesRolloutsListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
// PageSize sets the optional parameter "pageSize": The max number of
// items to include in the response list.
func (c *ServicesRolloutsListCall) PageSize(pageSize int64) *ServicesRolloutsListCall {
@@ -9410,6 +9490,11 @@
// "serviceName"
// ],
// "parameters": {
+ // "filter": {
+ // "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'",
+ // "location": "query",
+ // "type": "string"
+ // },
// "pageSize": {
// "description": "The max number of items to include in the response list.",
// "format": "int32",
diff --git a/serviceuser/v1/serviceuser-api.json b/serviceuser/v1/serviceuser-api.json
index 16b1056..1d8af27 100644
--- a/serviceuser/v1/serviceuser-api.json
+++ b/serviceuser/v1/serviceuser-api.json
@@ -1,4 +1,9 @@
{
+ "rootUrl": "https://serviceuser.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "serviceuser",
+ "batchPath": "batch",
+ "title": "Google Service User API",
"ownerName": "Google",
"resources": {
"projects": {
@@ -6,6 +11,12 @@
"services": {
"methods": {
"disable": {
+ "path": "v1/{+name}:disable",
+ "id": "serviceuser.projects.services.disable",
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
+ "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
"response": {
"$ref": "Operation"
},
@@ -15,37 +26,27 @@
"httpMethod": "POST",
"parameters": {
"name": {
- "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accepts the following forms for consumer:\n- \"project:\u003cproject_id\u003e\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:disable",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/services/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accepts the following forms for consumer:\n- \"project:\u003cproject_id\u003e\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:disable"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
- "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable",
- "path": "v1/{+name}:disable",
- "id": "serviceuser.projects.services.disable",
- "request": {
- "$ref": "DisableServiceRequest"
- },
- "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e"
+ "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable"
},
"enable": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
+ "parameterOrder": [
+ "name"
],
+ "httpMethod": "POST",
"parameters": {
"name": {
"description": "Name of the consumer and the service to enable for that consumer.\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:enable",
@@ -55,50 +56,54 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
"flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable",
- "id": "serviceuser.projects.services.enable",
"path": "v1/{+name}:enable",
- "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",
+ "id": "serviceuser.projects.services.enable",
"request": {
"$ref": "EnableServiceRequest"
- }
+ },
+ "description": "Enable a service so it can be used with a project.\nSee [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e"
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListEnabledServicesResponse"
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
"pageToken": {
- "type": "string",
"location": "query",
- "description": "Token identifying which result to start with; returned by a previous list\ncall."
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string"
},
"pageSize": {
+ "location": "query",
"description": "Requested size of the next page of data.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
"description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/services",
- "id": "serviceuser.projects.services.list",
"path": "v1/{+parent}/services",
- "description": "List enabled services for the specified consumer."
+ "id": "serviceuser.projects.services.list",
+ "description": "List enabled services for the specified consumer.",
+ "response": {
+ "$ref": "ListEnabledServicesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
}
}
}
@@ -115,15 +120,15 @@
},
"parameters": {
"pageToken": {
+ "location": "query",
"description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
- "location": "query",
"description": "Requested size of the next page of data.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
@@ -138,47 +143,16 @@
}
},
"parameters": {
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
"location": "query",
@@ -186,9 +160,9 @@
"type": "string"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enumDescriptions": [
@@ -209,12 +183,6 @@
"type": "string"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -222,36 +190,1347 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "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": {
+ "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"
+ },
+ "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://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": "",
+ "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.",
+ "kind": "discovery#restDescription",
"basePath": "",
"documentationLink": "https://cloud.google.com/service-management/",
"id": "serviceuser:v1",
- "revision": "20170505",
+ "revision": "20170526",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "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.",
+ "CustomHttpPattern": {
+ "description": "A custom pattern is used for defining custom HTTP verb.",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "The name of this custom HTTP verb.",
+ "type": "string"
+ },
+ "path": {
+ "description": "The path matched by this custom verb.",
+ "type": "string"
+ }
+ },
+ "id": "CustomHttpPattern"
+ },
+ "OperationMetadata": {
+ "id": "OperationMetadata",
+ "description": "The metadata associated with a long running operation resource.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "startTime": {
+ "description": "The start time of the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ }
+ },
+ "SystemParameterRule": {
+ "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
+ "type": "object",
+ "properties": {
+ "selector": {
+ "type": "string",
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details."
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "SystemParameter"
+ },
+ "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent."
+ }
+ },
+ "id": "SystemParameterRule"
+ },
+ "PublishedService": {
+ "type": "object",
+ "properties": {
+ "service": {
+ "$ref": "Service",
+ "description": "The service's published configuration."
+ },
+ "name": {
+ "type": "string",
+ "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com"
+ }
+ },
+ "id": "PublishedService",
+ "description": "The published version of a Service that is managed by\nGoogle Service Management."
+ },
+ "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 service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it 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": {
+ "type": "string",
+ "description": "Used for deleting a resource."
+ },
+ "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"
+ },
+ "restMethodName": {
+ "description": "Optional. The rest method name is by default derived from the URL\npattern. If specified, this field overrides the default method name.\nExample:\n\n rpc CreateResource(CreateResourceRequest)\n returns (CreateResourceResponse) {\n option (google.api.http) = {\n post: \"/v1/resources\",\n body: \"resource\",\n rest_method_name: \"insert\"\n };\n }\n\nThis method has the automatically derived rest method name \"create\", but\n for backwards compatability with apiary, it is specified as insert.",
+ "type": "string"
+ },
+ "additionalBindings": {
+ "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
+ "type": "array",
+ "items": {
+ "$ref": "HttpRule"
+ }
+ },
+ "restCollection": {
+ "description": "Optional. The REST collection name is by default derived from the URL\npattern. If specified, this field overrides the default collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggregatedListRequest)\n returns (AddressesAggregatedListResponse) {\n option (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/addresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\nThis method has the automatically derived collection name\n\"projects.aggregated\". Because, semantically, this rpc is actually an\noperation on the \"projects.addresses\" collection, the `rest_collection`\nfield is configured to override the derived collection name.",
+ "type": "string"
+ },
+ "responseBody": {
+ "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.",
+ "type": "string"
+ },
+ "mediaUpload": {
+ "$ref": "MediaUpload",
+ "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
+ },
+ "selector": {
+ "type": "string",
+ "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details."
+ },
+ "custom": {
+ "$ref": "CustomHttpPattern",
+ "description": "Custom pattern is used for defining custom verbs."
+ },
+ "patch": {
+ "type": "string",
+ "description": "Used for updating a resource."
+ },
+ "get": {
+ "description": "Used for listing and getting information about resources.",
+ "type": "string"
+ },
+ "put": {
+ "description": "Used for updating a resource.",
+ "type": "string"
+ }
+ }
+ },
+ "VisibilityRule": {
+ "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
+ "type": "object",
+ "properties": {
+ "restriction": {
+ "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "VisibilityRule"
+ },
+ "MonitoringDestination": {
+ "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
+ "type": "object",
+ "properties": {
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "MonitoringDestination"
+ },
+ "Visibility": {
+ "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "VisibilityRule"
+ }
+ }
+ },
+ "id": "Visibility"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "SystemParameterRule"
+ },
+ "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
+ }
+ },
+ "id": "SystemParameters"
+ },
+ "Quota": {
+ "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
+ "type": "object",
+ "properties": {
+ "limits": {
+ "description": "List of `QuotaLimit` definitions for the service.",
+ "type": "array",
+ "items": {
+ "$ref": "QuotaLimit"
+ }
+ },
+ "metricRules": {
+ "type": "array",
+ "items": {
+ "$ref": "MetricRule"
+ },
+ "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics."
+ }
+ },
+ "id": "Quota"
+ },
+ "Step": {
+ "description": "Represents the status of one operation step.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The short description of the step.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status code.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecifed code.",
+ "The operation or step has completed without errors.",
+ "The operation or step has not started yet.",
+ "The operation or step is in progress.",
+ "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.",
+ "The operation or step has completed with cancellation."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "DONE",
+ "NOT_STARTED",
+ "IN_PROGRESS",
+ "FAILED",
+ "CANCELLED"
+ ]
+ }
+ },
+ "id": "Step"
+ },
+ "LoggingDestination": {
+ "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
+ "type": "object",
+ "properties": {
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
+ "type": "string"
+ },
+ "logs": {
+ "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "LoggingDestination"
+ },
+ "Option": {
+ "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
+ "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"
+ }
+ },
+ "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": {
+ "type": "object",
+ "properties": {
+ "consumerDestinations": {
+ "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "LoggingDestination"
+ }
+ },
+ "producerDestinations": {
+ "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "LoggingDestination"
+ }
+ }
+ },
+ "id": "Logging",
+ "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history"
+ },
+ "Method": {
+ "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": {
+ "type": "boolean",
+ "description": "If true, the response is streamed."
+ },
+ "name": {
+ "type": "string",
+ "description": "The simple name of this method."
+ },
+ "requestTypeUrl": {
+ "description": "A URL of the input message type.",
+ "type": "string"
+ },
+ "requestStreaming": {
+ "description": "If true, the request is streamed.",
+ "type": "boolean"
+ },
+ "syntax": {
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of this method."
+ }
+ },
+ "id": "Method"
+ },
+ "QuotaLimit": {
+ "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "Tiered limit values, currently only STANDARD is supported.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "unit": {
+ "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com/service-control)\nsupports the following unit components:\n* One of the time intevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 hours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUsed by metric-based quotas only.",
+ "type": "string"
+ },
+ "maxLimit": {
+ "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
+ "type": "string"
+ },
+ "freeTier": {
+ "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "duration": {
+ "type": "string",
+ "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only."
+ },
+ "defaultLimit": {
+ "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "metric": {
+ "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.\n\nUsed by metric-based quotas only.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
+ "type": "string"
+ }
+ },
+ "id": "QuotaLimit"
+ },
+ "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": {
+ "type": "string",
+ "description": "The fully qualified name of the API which is included."
+ }
+ }
+ },
+ "CustomError": {
+ "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
+ "type": "object",
+ "properties": {
+ "types": {
+ "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "rules": {
+ "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "CustomErrorRule"
+ }
+ }
+ },
+ "id": "CustomError"
+ },
+ "Http": {
+ "description": "Defines the HTTP configuration for 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": {
+ "fullyDecodeReservedExpansion": {
+ "type": "boolean",
+ "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches."
+ },
+ "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": {
+ "type": "object",
+ "properties": {
+ "sourceFiles": {
+ "description": "All files used during config generation.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ }
+ },
+ "id": "SourceInfo",
+ "description": "Source information used to create a Service Config"
+ },
+ "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": {
+ "httpHeader": {
+ "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
+ "type": "string"
+ },
+ "urlQueryParameter": {
+ "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
+ "type": "string"
+ }
+ },
+ "id": "SystemParameter"
+ },
+ "Field": {
+ "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": {
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ },
+ "description": "The protocol buffer options."
+ },
+ "oneofIndex": {
+ "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "cardinality": {
+ "enum": [
+ "CARDINALITY_UNKNOWN",
+ "CARDINALITY_OPTIONAL",
+ "CARDINALITY_REQUIRED",
+ "CARDINALITY_REPEATED"
+ ],
+ "description": "The field cardinality.",
+ "type": "string",
+ "enumDescriptions": [
+ "For fields with unknown cardinality.",
+ "For optional fields.",
+ "For required fields. Proto2 syntax only.",
+ "For repeated fields."
+ ]
+ },
+ "packed": {
+ "description": "Whether to use alternative packed wire representation.",
+ "type": "boolean"
+ },
+ "defaultValue": {
+ "description": "The string value of the default value of this field. Proto2 syntax only.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The field name.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "MonitoringDestination"
+ },
+ "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination."
+ }
+ },
+ "id": "Monitoring"
+ },
+ "Enum": {
+ "description": "Enum type definition.",
+ "type": "object",
+ "properties": {
+ "options": {
+ "description": "Protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
+ },
+ "syntax": {
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax."
+ },
+ "name": {
+ "description": "Enum type name.",
+ "type": "string"
+ },
+ "enumvalue": {
+ "type": "array",
+ "items": {
+ "$ref": "EnumValue"
+ },
+ "description": "Enum value definitions."
+ }
+ },
+ "id": "Enum"
+ },
+ "EnableServiceRequest": {
+ "description": "Request message for EnableService method.",
+ "type": "object",
+ "properties": {},
+ "id": "EnableServiceRequest"
+ },
+ "LabelDescriptor": {
+ "description": "A description of a label.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "The label key.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A human-readable description for the label.",
+ "type": "string"
+ },
+ "valueType": {
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ],
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ],
+ "description": "The type of data that can be assigned to the label.",
+ "type": "string"
+ }
+ },
+ "id": "LabelDescriptor"
+ },
+ "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"
+ },
+ "Experimental": {
+ "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
+ "type": "object",
+ "properties": {
+ "authorization": {
+ "$ref": "AuthorizationConfig",
+ "description": "Authorization configuration."
+ }
+ },
+ "id": "Experimental"
+ },
+ "Backend": {
+ "description": "`Backend` defines the backend configuration for a service.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "DocumentationRule": {
+ "id": "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": {
+ "type": "string",
+ "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`."
+ },
+ "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"
+ }
+ }
+ },
+ "ContextRule": {
+ "description": "A context rule provides information about the context for an individual API\nelement.",
"type": "object",
"properties": {
"selector": {
"description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
},
- "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.",
+ "provided": {
+ "description": "A list of full type names of provided contexts.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "requested": {
+ "description": "A list of full type names of requested contexts.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
+ "The value is a `Distribution`.",
+ "The value is money."
+ ],
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported."
+ },
+ "metricKind": {
+ "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
+ ],
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ]
+ },
+ "displayName": {
+ "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "A detailed description of the metric, which can be used in documentation."
+ },
+ "unit": {
+ "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"
+ },
+ "ListEnabledServicesResponse": {
+ "description": "Response message for `ListEnabledServices` method.",
+ "type": "object",
+ "properties": {
+ "services": {
+ "description": "Services enabled for the specified parent.",
+ "type": "array",
+ "items": {
+ "$ref": "PublishedService"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListEnabledServices` to resume a paginated\nquery.",
+ "type": "string"
+ }
+ },
+ "id": "ListEnabledServicesResponse"
+ },
+ "Endpoint": {
+ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
+ "type": "object",
+ "properties": {
+ "features": {
+ "description": "The list of features enabled on this endpoint.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "apis": {
+ "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration.",
+ "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"
+ }
+ },
+ "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"
},
+ "target": {
+ "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "The canonical name of this endpoint.",
+ "type": "string"
+ }
+ },
+ "id": "Endpoint"
+ },
+ "OAuthRequirements": {
+ "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
+ "type": "object",
+ "properties": {
+ "canonicalScopes": {
+ "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
+ "type": "string"
+ }
+ },
+ "id": "OAuthRequirements"
+ },
+ "Usage": {
+ "id": "Usage",
+ "description": "Configuration controlling usage of a service.",
+ "type": "object",
+ "properties": {
+ "producerNotificationChannel": {
+ "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "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"
+ }
+ }
+ }
+ },
+ "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",
+ "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`."
+ },
+ "LogDescriptor": {
+ "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
+ "type": "object",
+ "properties": {
+ "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": {
+ "type": "string",
+ "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.]."
+ },
+ "description": {
+ "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
+ "type": "string"
+ }
+ },
+ "id": "LogDescriptor"
+ },
+ "MonitoredResourceDescriptor": {
+ "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": {
+ "name": {
+ "type": "string",
+ "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`."
+ },
+ "displayName": {
+ "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
+ "type": "string"
+ },
+ "description": {
+ "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"
+ }
+ }
+ }
+ },
+ "CustomErrorRule": {
+ "id": "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"
+ }
+ }
+ },
+ "MediaDownload": {
+ "id": "MediaDownload",
+ "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Whether download is enabled.",
+ "type": "boolean"
+ },
+ "downloadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
+ "type": "string"
+ },
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
+ "type": "boolean"
+ },
+ "dropzone": {
+ "type": "string",
+ "description": "Name of the Scotty dropzone to use for the current API."
+ },
+ "maxDirectDownloadSize": {
+ "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
+ "format": "int64",
+ "type": "string"
+ },
+ "useDirectDownload": {
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
+ "type": "boolean"
+ }
+ }
+ },
+ "CustomAuthRequirements": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
+ "type": "string"
+ }
+ },
+ "id": "CustomAuthRequirements",
+ "description": "Configuration for a custom authentication provider."
+ },
+ "DisableServiceRequest": {
+ "properties": {},
+ "id": "DisableServiceRequest",
+ "description": "Request message for DisableService method.",
+ "type": "object"
+ },
+ "SearchServicesResponse": {
+ "id": "SearchServicesResponse",
+ "description": "Response message for SearchServices method.",
+ "type": "object",
+ "properties": {
+ "services": {
+ "description": "Services available publicly or available to the authenticated caller.",
+ "type": "array",
+ "items": {
+ "$ref": "PublishedService"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
+ "type": "string"
+ }
+ }
+ },
+ "MediaUpload": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Whether upload is enabled.",
+ "type": "boolean"
+ },
+ "progressNotification": {
+ "description": "Whether to receive a notification for progress changes of media upload.",
+ "type": "boolean"
+ },
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
+ "type": "boolean"
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
+ },
+ "startNotification": {
+ "description": "Whether to receive a notification on the start of media upload.",
+ "type": "boolean"
+ },
+ "uploadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
+ "type": "string"
+ },
+ "mimeTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns."
+ },
+ "maxSize": {
+ "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "MediaUpload",
+ "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods."
+ },
+ "UsageRule": {
+ "id": "UsageRule",
+ "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ }
+ },
+ "AuthRequirement": {
+ "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",
+ "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32)."
+ },
+ "Documentation": {
+ "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
+ "type": "object",
+ "properties": {
+ "summary": {
+ "description": "A short summary of what the service does. Can only be provided by\nplain text.",
+ "type": "string"
+ },
+ "documentationRootUrl": {
+ "description": "The URL to the root of documentation.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "DocumentationRule"
+ }
+ },
+ "overview": {
+ "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
+ "type": "string"
+ },
+ "pages": {
+ "description": "The top level pages for the documentation set.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ }
+ },
+ "id": "Documentation"
+ },
+ "AuthenticationRule": {
+ "properties": {
"oauth": {
- "description": "The requirements for OAuth credentials.",
- "$ref": "OAuthRequirements"
+ "$ref": "OAuthRequirements",
+ "description": "The requirements for OAuth credentials."
},
"customAuth": {
"$ref": "CustomAuthRequirements",
@@ -263,9 +1542,19 @@
"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"
+ "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.",
@@ -286,15 +1575,13 @@
"type": "string"
},
"selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
}
},
"id": "BackendRule"
},
"Api": {
- "description": "Api is a light-weight descriptor for a protocol buffer service.",
- "type": "object",
"properties": {
"options": {
"description": "Any metadata attached to the API.",
@@ -342,10 +1629,12 @@
}
}
},
- "id": "Api"
+ "id": "Api",
+ "description": "Api is a light-weight descriptor for a protocol buffer service.",
+ "type": "object"
},
"MetricRule": {
- "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota, billing, and monitoring behaviors to apply to the\nmethod call.\n\nUsed by metric-based quotas only.",
+ "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
"type": "object",
"properties": {
"selector": {
@@ -364,7 +1653,6 @@
"id": "MetricRule"
},
"Authentication": {
- "id": "Authentication",
"description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
"type": "object",
"properties": {
@@ -382,9 +1670,11 @@
"$ref": "AuthProvider"
}
}
- }
+ },
+ "id": "Authentication"
},
"Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"done": {
@@ -392,20 +1682,20 @@
"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"
+ "type": "string",
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`."
},
"error": {
- "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": {
"type": "object",
@@ -416,18 +1706,12 @@
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any."
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
+ "id": "Operation"
},
"Page": {
- "id": "Page",
"description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"type": "object",
"properties": {
- "content": {
- "type": "string",
- "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file."
- },
"subpages": {
"description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
"type": "array",
@@ -438,11 +1722,16 @@
"name": {
"description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
"type": "string"
+ },
+ "content": {
+ "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
+ "type": "string"
}
- }
+ },
+ "id": "Page"
},
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` 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.\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.",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"message": {
@@ -453,17 +1742,17 @@
"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": {
- "type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
},
"id": "Status"
@@ -485,19 +1774,18 @@
"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"
+ "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"
}
},
"id": "AuthProvider"
},
"EnumValue": {
- "description": "Enum value definition.",
"type": "object",
"properties": {
"name": {
- "type": "string",
- "description": "Enum value name."
+ "description": "Enum value name.",
+ "type": "string"
},
"options": {
"description": "Protocol buffer options.",
@@ -512,11 +1800,54 @@
"type": "integer"
}
},
- "id": "EnumValue"
+ "id": "EnumValue",
+ "description": "Enum value definition."
},
"Service": {
"type": "object",
"properties": {
+ "types": {
+ "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
+ "type": "array",
+ "items": {
+ "$ref": "Type"
+ }
+ },
+ "sourceInfo": {
+ "$ref": "SourceInfo",
+ "description": "Output only. The source information for this configuration if available."
+ },
+ "http": {
+ "description": "HTTP configuration.",
+ "$ref": "Http"
+ },
+ "systemParameters": {
+ "$ref": "SystemParameters",
+ "description": "System parameter configuration."
+ },
+ "backend": {
+ "description": "API backend configuration.",
+ "$ref": "Backend"
+ },
+ "documentation": {
+ "$ref": "Documentation",
+ "description": "Additional API documentation."
+ },
+ "monitoredResources": {
+ "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ }
+ },
+ "logging": {
+ "$ref": "Logging",
+ "description": "Logging configuration."
+ },
+ "context": {
+ "description": "Context configuration.",
+ "$ref": "Context"
+ },
"enums": {
"description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
"type": "array",
@@ -524,10 +1855,6 @@
"$ref": "Enum"
}
},
- "context": {
- "$ref": "Context",
- "description": "Context configuration."
- },
"id": {
"description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
"type": "string"
@@ -544,8 +1871,8 @@
}
},
"authentication": {
- "$ref": "Authentication",
- "description": "Auth configuration."
+ "description": "Auth configuration.",
+ "$ref": "Authentication"
},
"experimental": {
"$ref": "Experimental",
@@ -565,11 +1892,11 @@
"$ref": "Monitoring"
},
"systemTypes": {
+ "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
"type": "array",
"items": {
"$ref": "Type"
- },
- "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF."
+ }
},
"producerProjectId": {
"description": "The 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.",
@@ -580,8 +1907,8 @@
"description": "API visibility configuration."
},
"quota": {
- "description": "Quota configuration.",
- "$ref": "Quota"
+ "$ref": "Quota",
+ "description": "Quota configuration."
},
"name": {
"description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
@@ -602,1303 +1929,28 @@
"$ref": "Endpoint"
}
},
+ "logs": {
+ "description": "Defines the logs used by this service.",
+ "type": "array",
+ "items": {
+ "$ref": "LogDescriptor"
+ }
+ },
"apis": {
"description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
"type": "array",
"items": {
"$ref": "Api"
}
- },
- "logs": {
- "type": "array",
- "items": {
- "$ref": "LogDescriptor"
- },
- "description": "Defines the logs used by this service."
- },
- "types": {
- "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
- "type": "array",
- "items": {
- "$ref": "Type"
- }
- },
- "sourceInfo": {
- "$ref": "SourceInfo",
- "description": "Output only. The source information for this configuration if available."
- },
- "http": {
- "description": "HTTP configuration.",
- "$ref": "Http"
- },
- "backend": {
- "$ref": "Backend",
- "description": "API backend configuration."
- },
- "systemParameters": {
- "description": "System parameter configuration.",
- "$ref": "SystemParameters"
- },
- "documentation": {
- "$ref": "Documentation",
- "description": "Additional API documentation."
- },
- "logging": {
- "$ref": "Logging",
- "description": "Logging configuration."
- },
- "monitoredResources": {
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
- "type": "array",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- }
}
},
"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"
- },
- "OperationMetadata": {
- "type": "object",
- "properties": {
- "startTime": {
- "description": "The start time of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "resourceNames": {
- "description": "The full name of the resources that this operation is directly\nassociated with.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "steps": {
- "description": "Detailed status information for each step. The order is undetermined.",
- "type": "array",
- "items": {
- "$ref": "Step"
- }
- },
- "progressPercentage": {
- "description": "Percentage of completion of this operation, ranging from 0 to 100.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "OperationMetadata",
- "description": "The metadata associated with a long running operation resource."
- },
- "CustomHttpPattern": {
- "description": "A custom pattern is used for defining custom HTTP verb.",
- "type": "object",
- "properties": {
- "path": {
- "description": "The path matched by this custom verb.",
- "type": "string"
- },
- "kind": {
- "description": "The name of this custom HTTP verb.",
- "type": "string"
- }
- },
- "id": "CustomHttpPattern"
- },
- "PublishedService": {
- "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",
- "description": "The published version of a Service that is managed by\nGoogle Service Management.",
- "type": "object"
- },
- "SystemParameterRule": {
- "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
- "type": "object",
- "properties": {
- "parameters": {
- "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
- "type": "array",
- "items": {
- "$ref": "SystemParameter"
- }
- },
- "selector": {
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
- "type": "string"
- }
- },
- "id": "SystemParameterRule"
- },
- "HttpRule": {
- "properties": {
- "mediaUpload": {
- "$ref": "MediaUpload",
- "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
- },
- "selector": {
- "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "custom": {
- "description": "Custom pattern is used for defining custom verbs.",
- "$ref": "CustomHttpPattern"
- },
- "patch": {
- "description": "Used for updating a resource.",
- "type": "string"
- },
- "get": {
- "description": "Used for listing and getting information about resources.",
- "type": "string"
- },
- "put": {
- "description": "Used for updating a resource.",
- "type": "string"
- },
- "delete": {
- "description": "Used for deleting a resource.",
- "type": "string"
- },
- "body": {
- "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
- "type": "string"
- },
- "mediaDownload": {
- "$ref": "MediaDownload",
- "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
- },
- "post": {
- "description": "Used for creating a resource.",
- "type": "string"
- },
- "additionalBindings": {
- "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
- "type": "array",
- "items": {
- "$ref": "HttpRule"
- }
- },
- "responseBody": {
- "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.",
- "type": "string"
- },
- "restCollection": {
- "description": "Optional. The REST collection name is by default derived from the URL\npattern. If specified, this field overrides the default collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggregatedListRequest)\n returns (AddressesAggregatedListResponse) {\n option (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/addresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\nThis method has the automatically derived collection name\n\"projects.aggregated\". Because, semantically, this rpc is actually an\noperation on the \"projects.addresses\" collection, the `rest_collection`\nfield is configured to override the derived collection name.",
- "type": "string"
- }
- },
- "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"
- },
- "VisibilityRule": {
- "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
- "type": "object",
- "properties": {
- "restriction": {
- "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
- "type": "string"
- },
- "selector": {
- "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- }
- },
- "id": "VisibilityRule"
- },
- "MonitoringDestination": {
- "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
- "type": "object",
- "properties": {
- "metrics": {
- "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
- }
- },
- "id": "MonitoringDestination"
- },
- "Visibility": {
- "properties": {
- "rules": {
- "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "VisibilityRule"
- }
- }
- },
- "id": "Visibility",
- "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
- "type": "object"
- },
- "SystemParameters": {
- "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "SystemParameterRule"
- }
- }
- },
- "id": "SystemParameters"
- },
- "Quota": {
- "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
- "type": "object",
- "properties": {
- "limits": {
- "description": "List of `QuotaLimit` definitions for the service.\n\nUsed by metric-based quotas only.",
- "type": "array",
- "items": {
- "$ref": "QuotaLimit"
- }
- },
- "metricRules": {
- "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.\n\nUsed by metric-based quotas only.",
- "type": "array",
- "items": {
- "$ref": "MetricRule"
- }
- }
- },
- "id": "Quota"
- },
- "Step": {
- "type": "object",
- "properties": {
- "description": {
- "description": "The short description of the step.",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "Unspecifed code.",
- "The operation or step has completed without errors.",
- "The operation or step has not started yet.",
- "The operation or step is in progress.",
- "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.",
- "The operation or step has completed with cancellation.",
- "The operation has completed with errors but rolled back\nsuccessfully if the operation is rollbackable."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "DONE",
- "NOT_STARTED",
- "IN_PROGRESS",
- "FAILED",
- "CANCELLED",
- "FAILED_ROLLED_BACK"
- ],
- "description": "The status code.",
- "type": "string"
- }
- },
- "id": "Step",
- "description": "Represents the status of one operation step."
- },
- "LoggingDestination": {
- "id": "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"
- }
- }
- },
- "Option": {
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
- "type": "string"
- },
- "value": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
- "type": "object"
- }
- },
- "id": "Option"
- },
- "Logging": {
- "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
- "type": "object",
- "properties": {
- "consumerDestinations": {
- "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
- "type": "array",
- "items": {
- "$ref": "LoggingDestination"
- }
- },
- "producerDestinations": {
- "type": "array",
- "items": {
- "$ref": "LoggingDestination"
- },
- "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."
- }
- },
- "id": "Logging"
- },
- "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": {
- "description": "The source syntax of this method.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ]
- }
- },
- "id": "Method"
- },
- "QuotaLimit": {
- "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
- "type": "object",
- "properties": {
- "values": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "Tiered limit values. Also allows for regional or zone overrides for these\nvalues if \"/{region}\" or \"/{zone}\" is specified in the unit field.\n\nCurrently supported tiers from low to high:\nVERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH\n\nTo apply different limit values for users according to their tiers, specify\nthe values for the tiers you want to differentiate. For example:\n{LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}\n\nThe limit value for each tier is optional except for the tier STANDARD.\nThe limit value for an unspecified tier falls to the value of its next\ntier towards tier STANDARD. For the above example, the limit value for tier\nSTANDARD is 500.\n\nTo apply the same limit value for all users, just specify limit value for\ntier STANDARD. For example: {STANDARD:500}.\n\nTo apply a regional overide for a tier, add a map entry with key\n\"\u003cTIER\u003e/\u003cregion\u003e\", where \u003cregion\u003e is a region name. Similarly, for a zone\noverride, add a map entry with key \"\u003cTIER\u003e/{zone}\".\nFurther, a wildcard can be used at the end of a zone name in order to\nspecify zone level overrides. For example:\nLOW: 10, STANDARD: 50, HIGH: 100,\nLOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1: 200,\nLOW/us-central1-*: 10, STANDARD/us-central1-*: 20, HIGH/us-central1-*: 80\n\nThe regional overrides tier set for each region must be the same as\nthe tier set for default limit values. Same rule applies for zone overrides\ntier as well.\n\nUsed by metric-based quotas only.",
- "type": "object"
- },
- "unit": {
- "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com/service-control)\nsupports the following unit components:\n* One of the time intevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 hours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{organization}\" quota for an organization.\n * \"/{project}\" quota for a project.\n * \"/{folder}\" quota for a folder.\n * \"/{resource}\" quota for a universal resource.\n* Zero or more quota segmentation dimension. Not all combos are valid.\n * \"/{region}\" quota for every region. Not to be used with time intervals.\n * Otherwise the resources granted on the target is not segmented.\n * \"/{zone}\" quota for every zone. Not to be used with time intervals.\n * Otherwise the resources granted on the target is not segmented.\n * \"/{resource}\" quota for a resource associated with a project or org.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n* \"1/min/{user}\" for quota per minute per user.\n* \"1/min/{organization}\" for quota per minute per organization.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUsed by metric-based quotas only.",
- "type": "string"
- },
- "maxLimit": {
- "type": "string",
- "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
- "format": "int64"
- },
- "name": {
- "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor group-based quota limits, the name must be unique within the quota\ngroup. If a name is not provided, it will be generated from the limit_by\nand duration fields.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
- "type": "string"
- },
- "freeTier": {
- "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
- "format": "int64",
- "type": "string"
- },
- "duration": {
- "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
- "type": "string"
- },
- "defaultLimit": {
- "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
- "format": "int64",
- "type": "string"
- },
- "displayName": {
- "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
- "type": "string"
- },
- "metric": {
- "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.\n\nUsed by metric-based quotas only.",
- "type": "string"
- },
- "description": {
- "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
- "type": "string"
- }
- },
- "id": "QuotaLimit"
- },
- "Mixin": {
- "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",
- "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 }"
- },
- "CustomError": {
- "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",
- "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
- "type": "object"
- },
- "Http": {
- "description": "Defines the HTTP configuration for 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": {
- "fullyDecodeReservedExpansion": {
- "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
- "type": "boolean"
- },
- "rules": {
- "description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "HttpRule"
- }
- }
- },
- "id": "Http"
- },
- "SourceInfo": {
- "description": "Source information used to create a Service Config",
- "type": "object",
- "properties": {
- "sourceFiles": {
- "description": "All files used during config generation.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- }
- },
- "id": "SourceInfo"
- },
- "Control": {
- "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
- "type": "object",
- "properties": {
- "environment": {
- "type": "string",
- "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled."
- }
- },
- "id": "Control"
- },
- "SystemParameter": {
- "id": "SystemParameter",
- "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
- "type": "object",
- "properties": {
- "urlQueryParameter": {
- "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
- "type": "string"
- },
- "httpHeader": {
- "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
- "type": "string"
- },
- "name": {
- "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
- "type": "string"
- }
- }
- },
- "Monitoring": {
- "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",
- "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"
- },
- "Field": {
- "id": "Field",
- "description": "A single field of a message type.",
- "type": "object",
- "properties": {
- "cardinality": {
- "enumDescriptions": [
- "For fields with unknown cardinality.",
- "For optional fields.",
- "For required fields. Proto2 syntax only.",
- "For repeated fields."
- ],
- "enum": [
- "CARDINALITY_UNKNOWN",
- "CARDINALITY_OPTIONAL",
- "CARDINALITY_REQUIRED",
- "CARDINALITY_REPEATED"
- ],
- "description": "The field cardinality.",
- "type": "string"
- },
- "packed": {
- "description": "Whether to use alternative packed wire representation.",
- "type": "boolean"
- },
- "defaultValue": {
- "description": "The string value of the default value of this field. Proto2 syntax only.",
- "type": "string"
- },
- "name": {
- "description": "The field name.",
- "type": "string"
- },
- "typeUrl": {
- "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
- "type": "string"
- },
- "number": {
- "description": "The field number.",
- "format": "int32",
- "type": "integer"
- },
- "jsonName": {
- "type": "string",
- "description": "The field JSON name."
- },
- "kind": {
- "enum": [
- "TYPE_UNKNOWN",
- "TYPE_DOUBLE",
- "TYPE_FLOAT",
- "TYPE_INT64",
- "TYPE_UINT64",
- "TYPE_INT32",
- "TYPE_FIXED64",
- "TYPE_FIXED32",
- "TYPE_BOOL",
- "TYPE_STRING",
- "TYPE_GROUP",
- "TYPE_MESSAGE",
- "TYPE_BYTES",
- "TYPE_UINT32",
- "TYPE_ENUM",
- "TYPE_SFIXED32",
- "TYPE_SFIXED64",
- "TYPE_SINT32",
- "TYPE_SINT64"
- ],
- "description": "The field type.",
- "type": "string",
- "enumDescriptions": [
- "Field type unknown.",
- "Field type double.",
- "Field type float.",
- "Field type int64.",
- "Field type uint64.",
- "Field type int32.",
- "Field type fixed64.",
- "Field type fixed32.",
- "Field type bool.",
- "Field type string.",
- "Field type group. Proto2 syntax only, and deprecated.",
- "Field type message.",
- "Field type bytes.",
- "Field type uint32.",
- "Field type enum.",
- "Field type sfixed32.",
- "Field type sfixed64.",
- "Field type sint32.",
- "Field type sint64."
- ]
- },
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "oneofIndex": {
- "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "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": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "syntax": {
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ]
- }
- },
- "id": "Enum"
- },
- "EnableServiceRequest": {
- "properties": {},
- "id": "EnableServiceRequest",
- "description": "Request message for EnableService method.",
- "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"
- },
- "Type": {
- "id": "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": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The list of types appearing in `oneof` definitions in this type."
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- },
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- }
- }
- },
- "Experimental": {
- "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
- "type": "object",
- "properties": {
- "authorization": {
- "$ref": "AuthorizationConfig",
- "description": "Authorization configuration."
- }
- },
- "id": "Experimental"
- },
- "Backend": {
- "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",
- "description": "`Backend` defines the backend configuration for a service."
- },
- "DocumentationRule": {
- "id": "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": {
- "type": "string",
- "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`."
- },
- "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": {
- "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
- "type": "string"
- }
- },
- "id": "AuthorizationConfig"
- },
- "ContextRule": {
- "description": "A context rule provides information about the context for an individual API\nelement.",
- "type": "object",
- "properties": {
- "provided": {
- "description": "A list of full type names of provided contexts.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "requested": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "A list of full type names of requested contexts."
- },
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- }
- },
- "id": "ContextRule"
- },
- "SourceContext": {
- "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",
- "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined."
- },
- "MetricDescriptor": {
- "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
- "type": "object",
- "properties": {
- "unit": {
- "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
- "type": "string"
- },
- "labels": {
- "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "The resource name of the metric descriptor. 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": {
- "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
- ],
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ]
- },
- "description": {
- "description": "A detailed description of the metric, which can be used in documentation.",
- "type": "string"
- },
- "displayName": {
- "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".",
- "type": "string"
- }
- },
- "id": "MetricDescriptor"
- },
- "ListEnabledServicesResponse": {
- "properties": {
- "services": {
- "description": "Services enabled for the specified parent.",
- "type": "array",
- "items": {
- "$ref": "PublishedService"
- }
- },
- "nextPageToken": {
- "description": "Token that can be passed to `ListEnabledServices` to resume a paginated\nquery.",
- "type": "string"
- }
- },
- "id": "ListEnabledServicesResponse",
- "description": "Response message for `ListEnabledServices` method.",
- "type": "object"
- },
- "Endpoint": {
- "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
- "type": "object",
- "properties": {
- "apis": {
- "description": "The list of APIs served by this endpoint.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "allowCors": {
- "type": "boolean",
- "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed."
- },
- "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"
- }
- },
- "name": {
- "description": "The canonical name of this endpoint.",
- "type": "string"
- },
- "target": {
- "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
- "type": "string"
- },
- "features": {
- "description": "The list of features enabled on this endpoint.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "Endpoint"
- },
- "OAuthRequirements": {
- "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
- "type": "object",
- "properties": {
- "canonicalScopes": {
- "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
- "type": "string"
- }
- },
- "id": "OAuthRequirements"
- },
- "Usage": {
- "description": "Configuration controlling usage of a service.",
- "type": "object",
- "properties": {
- "producerNotificationChannel": {
- "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
- "type": "string"
- },
- "rules": {
- "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "UsageRule"
- }
- },
- "requirements": {
- "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "Usage"
- },
- "Context": {
- "id": "Context",
- "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "ContextRule"
- }
- }
- }
- },
- "LogDescriptor": {
- "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
- "type": "object",
- "properties": {
- "labels": {
- "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
- "type": "string"
- },
- "description": {
- "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
- "type": "string"
- },
- "displayName": {
- "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
- "type": "string"
- }
- },
- "id": "LogDescriptor"
- },
- "MonitoredResourceDescriptor": {
- "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
- "type": "string"
- }
- },
- "id": "MonitoredResourceDescriptor"
- },
- "CustomErrorRule": {
- "description": "A custom error rule.",
- "type": "object",
- "properties": {
- "isErrorType": {
- "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
- "type": "boolean"
- },
- "selector": {
- "type": "string",
- "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details."
- }
- },
- "id": "CustomErrorRule"
- },
- "CustomAuthRequirements": {
- "description": "Configuration for a custom authentication provider.",
- "type": "object",
- "properties": {
- "provider": {
- "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
- "type": "string"
- }
- },
- "id": "CustomAuthRequirements"
- },
- "MediaDownload": {
- "description": "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"
- }
- },
- "id": "MediaDownload"
- },
- "DisableServiceRequest": {
- "type": "object",
- "properties": {},
- "id": "DisableServiceRequest",
- "description": "Request message for DisableService method."
- },
- "SearchServicesResponse": {
- "description": "Response message for SearchServices method.",
- "type": "object",
- "properties": {
- "services": {
- "description": "Services available publicly or available to the authenticated caller.",
- "type": "array",
- "items": {
- "$ref": "PublishedService"
- }
- },
- "nextPageToken": {
- "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
- "type": "string"
- }
- },
- "id": "SearchServicesResponse"
- },
- "MediaUpload": {
- "description": "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": {
- "type": "boolean",
- "description": "Whether upload is enabled."
- }
- },
- "id": "MediaUpload"
- },
- "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": {
- "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
- "type": "object",
- "properties": {
- "providerId": {
- "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
- "type": "string"
- },
- "audiences": {
- "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
- "type": "string"
- }
- },
- "id": "AuthRequirement"
- },
- "Documentation": {
- "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": {
- "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."
- }
- },
- "id": "Documentation",
- "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
- "type": "object"
}
},
"icons": {
- "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",
@@ -1916,10 +1968,5 @@
}
}
}
- },
- "rootUrl": "https://serviceuser.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "serviceuser",
- "batchPath": "batch",
- "title": "Google Service User API"
+ }
}
diff --git a/serviceuser/v1/serviceuser-gen.go b/serviceuser/v1/serviceuser-gen.go
index 9e6c78d..03eb78c 100644
--- a/serviceuser/v1/serviceuser-gen.go
+++ b/serviceuser/v1/serviceuser-gen.go
@@ -1093,6 +1093,10 @@
AllowCors bool `json:"allowCors,omitempty"`
// Apis: The list of APIs served by this endpoint.
+ //
+ // If no APIs are specified this translates to "all APIs" exported by
+ // the
+ // service, as defined in the top-level service configuration.
Apis []string `json:"apis,omitempty"`
// Features: The list of features enabled on this endpoint.
@@ -1444,6 +1448,11 @@
// message:
//
//
+// service Messaging {
+// rpc GetMessage(GetMessageRequest) returns (Message) {
+// option (google.api.http).get = "/v1/messages/{message_id}";
+// }
+// }
// message GetMessageRequest {
// message SubMessage {
// string subfield = 1;
@@ -1713,6 +1722,26 @@
// field is configured to override the derived collection name.
RestCollection string `json:"restCollection,omitempty"`
+ // RestMethodName: Optional. The rest method name is by default derived
+ // from the URL
+ // pattern. If specified, this field overrides the default method
+ // name.
+ // Example:
+ //
+ // rpc CreateResource(CreateResourceRequest)
+ // returns (CreateResourceResponse) {
+ // option (google.api.http) = {
+ // post: "/v1/resources",
+ // body: "resource",
+ // rest_method_name: "insert"
+ // };
+ // }
+ //
+ // This method has the automatically derived rest method name "create",
+ // but
+ // for backwards compatability with apiary, it is specified as insert.
+ RestMethodName string `json:"restMethodName,omitempty"`
+
// Selector: Selects methods to which this rule applies.
//
// Refer to selector for syntax details.
@@ -1991,30 +2020,51 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// MediaDownload: Use this only for Scotty Requests. Do not use this for
-// media support using
+// MediaDownload: Defines the Media configuration for a service in case
+// of a download.
+// Use this only for Scotty Requests. Do not use this for media support
+// using
// Bytestream, add instead [][google.bytestream.RestByteStream] as an
// API to
// your configuration for Bytestream methods.
type MediaDownload struct {
- // DownloadService: DO NOT USE THIS FIELD UNTIL THIS WARNING IS
- // REMOVED.
+ // CompleteNotification: A boolean that determines whether a
+ // notification for the completion of a
+ // download should be sent to the backend.
+ CompleteNotification bool `json:"completeNotification,omitempty"`
+
+ // DownloadService: DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING
+ // IS REMOVED.
//
// Specify name of the download service if one is used for download.
DownloadService string `json:"downloadService,omitempty"`
+ // Dropzone: Name of the Scotty dropzone to use for the current API.
+ Dropzone string `json:"dropzone,omitempty"`
+
// Enabled: Whether download is enabled.
Enabled bool `json:"enabled,omitempty"`
- // ForceSendFields is a list of field names (e.g. "DownloadService") 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.
+ // MaxDirectDownloadSize: Optional maximum acceptable size for direct
+ // download.
+ // The size is specified in bytes.
+ MaxDirectDownloadSize int64 `json:"maxDirectDownloadSize,omitempty,string"`
+
+ // UseDirectDownload: A boolean that determines if direct download from
+ // ESF should be used for
+ // download of this media.
+ UseDirectDownload bool `json:"useDirectDownload,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "CompleteNotification") 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. "DownloadService") to
+ // NullFields is a list of field names (e.g. "CompleteNotification") 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
@@ -2030,35 +2080,66 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// MediaUpload: Use this only for Scotty Requests. Do not use this for
-// media support using
+// MediaUpload: Defines the Media configuration for a service in case of
+// an upload.
+// Use this only for Scotty Requests. Do not use this for media support
+// using
// Bytestream, add instead [][google.bytestream.RestByteStream] as an
// API to
// your configuration for Bytestream methods.
type MediaUpload struct {
+ // CompleteNotification: A boolean that determines whether a
+ // notification for the completion of an
+ // upload should be sent to the backend. These notifications will not be
+ // seen
+ // by the client and will not consume quota.
+ CompleteNotification bool `json:"completeNotification,omitempty"`
+
+ // Dropzone: Name of the Scotty dropzone to use for the current API.
+ Dropzone string `json:"dropzone,omitempty"`
+
// Enabled: Whether upload is enabled.
Enabled bool `json:"enabled,omitempty"`
- // UploadService: DO NOT USE THIS FIELD UNTIL THIS WARNING IS
- // REMOVED.
+ // MaxSize: Optional maximum acceptable size for an upload.
+ // The size is specified in bytes.
+ MaxSize int64 `json:"maxSize,omitempty,string"`
+
+ // MimeTypes: An array of mimetype patterns. Esf will only accept
+ // uploads that match one
+ // of the given patterns.
+ MimeTypes []string `json:"mimeTypes,omitempty"`
+
+ // ProgressNotification: Whether to receive a notification for progress
+ // changes of media upload.
+ ProgressNotification bool `json:"progressNotification,omitempty"`
+
+ // StartNotification: Whether to receive a notification on the start of
+ // media upload.
+ StartNotification bool `json:"startNotification,omitempty"`
+
+ // UploadService: DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING
+ // IS REMOVED.
//
// Specify name of the upload service if one is used for upload.
UploadService string `json:"uploadService,omitempty"`
- // ForceSendFields is a list of field names (e.g. "Enabled") 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 is a list of field names (e.g.
+ // "CompleteNotification") 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. "Enabled") 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. "CompleteNotification") 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:"-"`
}
@@ -2301,11 +2382,7 @@
// MetricRule: Bind API methods to metrics. Binding a method to a metric
// causes that
-// metric's configured quota, billing, and monitoring behaviors to apply
-// to the
-// method call.
-//
-// Used by metric-based quotas only.
+// metric's configured quota behaviors to apply to the method call.
type MetricRule struct {
// MetricCosts: Metrics to update when the selected methods are called,
// and the associated
@@ -3041,15 +3118,11 @@
// value_type: INT64
type Quota struct {
// Limits: List of `QuotaLimit` definitions for the service.
- //
- // Used by metric-based quotas only.
Limits []*QuotaLimit `json:"limits,omitempty"`
// MetricRules: List of `MetricRule` definitions, each one mapping a
// selected method to one
// or more metrics.
- //
- // Used by metric-based quotas only.
MetricRules []*MetricRule `json:"metricRules,omitempty"`
// ForceSendFields is a list of field names (e.g. "Limits") to
@@ -3169,12 +3242,6 @@
// when
// overriding the default limit on per-consumer basis.
//
- // For group-based quota limits, the name must be unique within the
- // quota
- // group. If a name is not provided, it will be generated from the
- // limit_by
- // and duration fields.
- //
// For metric-based quota limits, the name must be provided, and it must
// be
// unique within the service. The name can only include
@@ -3209,26 +3276,10 @@
// * Otherwise the quota won't be reset by time, such as storage
// limit.
// * One and only one of the granted containers:
- // * "/{organization}" quota for an organization.
- // * "/{project}" quota for a project.
- // * "/{folder}" quota for a folder.
- // * "/{resource}" quota for a universal resource.
- // * Zero or more quota segmentation dimension. Not all combos are
- // valid.
- // * "/{region}" quota for every region. Not to be used with time
- // intervals.
- // * Otherwise the resources granted on the target is not segmented.
- // * "/{zone}" quota for every zone. Not to be used with time
- // intervals.
- // * Otherwise the resources granted on the target is not segmented.
- // * "/{resource}" quota for a resource associated with a project or
- // org.
+ // * "/{project}" quota for a project
//
// Here are some examples:
// * "1/min/{project}" for quota per minute per project.
- // * "1/min/{user}" for quota per minute per user.
- // * "1/min/{organization}" for quota per minute per
- // organization.
//
// Note: the order of unit components is insignificant.
// The "1" at the beginning is required to follow the metric unit
@@ -3237,53 +3288,7 @@
// Used by metric-based quotas only.
Unit string `json:"unit,omitempty"`
- // Values: Tiered limit values. Also allows for regional or zone
- // overrides for these
- // values if "/{region}" or "/{zone}" is specified in the unit
- // field.
- //
- // Currently supported tiers from low to high:
- // VERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH
- //
- // To apply different limit values for users according to their tiers,
- // specify
- // the values for the tiers you want to differentiate. For
- // example:
- // {LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}
- //
- // The limit value for each tier is optional except for the tier
- // STANDARD.
- // The limit value for an unspecified tier falls to the value of its
- // next
- // tier towards tier STANDARD. For the above example, the limit value
- // for tier
- // STANDARD is 500.
- //
- // To apply the same limit value for all users, just specify limit value
- // for
- // tier STANDARD. For example: {STANDARD:500}.
- //
- // To apply a regional overide for a tier, add a map entry with
- // key
- // "<TIER>/<region>", where <region> is a region name. Similarly, for a
- // zone
- // override, add a map entry with key "<TIER>/{zone}".
- // Further, a wildcard can be used at the end of a zone name in order
- // to
- // specify zone level overrides. For example:
- // LOW: 10, STANDARD: 50, HIGH: 100,
- // LOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1:
- // 200,
- // LOW/us-central1-*: 10, STANDARD/us-central1-*: 20,
- // HIGH/us-central1-*: 80
- //
- // The regional overrides tier set for each region must be the same
- // as
- // the tier set for default limit values. Same rule applies for zone
- // overrides
- // tier as well.
- //
- // Used by metric-based quotas only.
+ // Values: Tiered limit values, currently only STANDARD is supported.
Values map[string]string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "DefaultLimit") to
@@ -3628,7 +3633,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -3736,9 +3741,6 @@
// rollbackable, the rollback completed with errors too.
// "CANCELLED" - The operation or step has completed with
// cancellation.
- // "FAILED_ROLLED_BACK" - The operation has completed with errors but
- // rolled back
- // successfully if the operation is rollbackable.
Status string `json:"status,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
diff --git a/sheets/v4/sheets-api.json b/sheets/v4/sheets-api.json
index 7dbbc35..e5805b7 100644
--- a/sheets/v4/sheets-api.json
+++ b/sheets/v4/sheets-api.json
@@ -1,119 +1,97 @@
{
- "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": {
- "ranges": {
- "repeated": true,
- "location": "query",
- "description": "The ranges to retrieve from the spreadsheet.",
- "type": "string"
- },
- "includeGridData": {
- "type": "boolean",
- "location": "query",
- "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request."
- },
- "spreadsheetId": {
- "location": "path",
- "description": "The spreadsheet to request.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/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": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets",
- "path": "v4/spreadsheets",
- "id": "sheets.spreadsheets.create",
- "request": {
- "$ref": "Spreadsheet"
- },
- "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- },
- "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": {
- "description": "The spreadsheet to apply the updates to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "id": "sheets.spreadsheets.batchUpdate"
- }
- },
"resources": {
"values": {
"methods": {
- "batchClear": {
- "request": {
- "$ref": "BatchClearValuesRequest"
+ "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"
},
- "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "httpMethod": "POST",
"parameterOrder": [
"spreadsheetId"
],
- "response": {
- "$ref": "BatchClearValuesResponse"
+ "httpMethod": "GET",
+ "parameters": {
+ "valueRenderOption": {
+ "location": "query",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string"
+ },
+ "dateTimeRenderOption": {
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ]
+ },
+ "ranges": {
+ "description": "The A1 notation of the values to retrieve.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "majorDimension": {
+ "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "required": true,
+ "type": "string"
+ }
},
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/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"
+ },
+ "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.",
+ "response": {
+ "$ref": "ClearValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "POST",
"parameters": {
"spreadsheetId": {
"location": "path",
"description": "The ID of the spreadsheet to update.",
"required": true,
"type": "string"
+ },
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of the values to clear.",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
@@ -121,26 +99,143 @@
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/spreadsheets"
],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "id": "sheets.spreadsheets.values.batchClear",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear"
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "id": "sheets.spreadsheets.values.clear"
},
- "get": {
- "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.",
- "httpMethod": "GET",
- "response": {
+ "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": {
+ "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"
+ },
+ "insertDataOption": {
+ "description": "How the input data should be inserted.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "OVERWRITE",
+ "INSERT_ROWS"
+ ]
+ },
+ "valueInputOption": {
+ "description": "How the input data should be interpreted.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ]
+ },
+ "responseDateTimeRenderOption": {
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
+ },
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
+ "type": "boolean",
+ "location": "query"
+ },
"range": {
- "description": "The A1 notation of the values to retrieve.",
+ "location": "path",
+ "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
+ "id": "sheets.spreadsheets.values.append",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append"
+ },
+ "batchClear": {
+ "request": {
+ "$ref": "BatchClearValuesRequest"
+ },
+ "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
+ "response": {
+ "$ref": "BatchClearValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
"required": true,
"type": "string",
"location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
+ "id": "sheets.spreadsheets.values.batchClear"
+ },
+ "get": {
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.get",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "response": {
+ "$ref": "ValueRange"
+ },
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of the values to retrieve.",
+ "required": true,
+ "type": "string"
},
"valueRenderOption": {
"location": "query",
@@ -170,12 +265,6 @@
],
"description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
"type": "string"
- },
- "spreadsheetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve data from."
}
},
"scopes": [
@@ -184,12 +273,11 @@
"https://www.googleapis.com/auth/drive.readonly",
"https://www.googleapis.com/auth/spreadsheets",
"https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.get",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}"
+ ]
},
"update": {
+ "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"
@@ -208,205 +296,16 @@
"https://www.googleapis.com/auth/spreadsheets"
],
"parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string"
- },
- "responseValueRenderOption": {
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string",
- "location": "query",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ]
- },
- "valueInputOption": {
- "description": "How the input data should be interpreted.",
- "type": "string",
- "location": "query",
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ]
- },
- "responseDateTimeRenderOption": {
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string",
- "location": "query"
- },
"includeValuesInResponse": {
- "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"
+ "type": "boolean",
+ "location": "query"
},
"range": {
"location": "path",
"description": "The A1 notation of the values to update.",
"required": true,
"type": "string"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.update"
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate"
- },
- "batchGet": {
- "httpMethod": "GET",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchGetValuesResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to retrieve data from.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "valueRenderOption": {
- "type": "string",
- "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."
- },
- "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": {
- "location": "query",
- "description": "The A1 notation of the values to retrieve.",
- "type": "string",
- "repeated": true
- },
- "majorDimension": {
- "location": "query",
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
- "id": "sheets.spreadsheets.values.batchGet",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
- "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges."
- },
- "clear": {
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
- "id": "sheets.spreadsheets.values.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.",
- "response": {
- "$ref": "ClearValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "httpMethod": "POST",
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string"
- },
- "range": {
- "description": "The A1 notation of the values to clear.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear"
- },
- "append": {
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "response": {
- "$ref": "AppendValuesResponse"
- },
- "parameters": {
- "includeValuesInResponse": {
- "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
- "type": "boolean",
- "location": "query"
- },
- "range": {
- "location": "path",
- "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
- "required": true,
- "type": "string"
},
"spreadsheetId": {
"location": "path",
@@ -415,33 +314,24 @@
"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"
- },
- "insertDataOption": {
- "location": "query",
- "enum": [
- "OVERWRITE",
- "INSERT_ROWS"
- ],
- "description": "How the input data should be inserted.",
- "type": "string"
+ "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"
+ "type": "string",
+ "location": "query"
},
"responseDateTimeRenderOption": {
"location": "query",
@@ -453,31 +343,42 @@
"type": "string"
}
},
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}"
+ },
+ "batchUpdate": {
+ "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges.",
+ "request": {
+ "$ref": "BatchUpdateValuesRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "BatchUpdateValuesResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/spreadsheets"
],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
- "id": "sheets.spreadsheets.values.append",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
- "request": {
- "$ref": "ValueRange"
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
},
- "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."
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
+ "id": "sheets.spreadsheets.values.batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate"
}
}
},
"sheets": {
"methods": {
"copyTo": {
- "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
- "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
- "id": "sheets.spreadsheets.sheets.copyTo",
- "request": {
- "$ref": "CopySheetToAnotherSpreadsheetRequest"
- },
- "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
"response": {
"$ref": "SheetProperties"
},
@@ -486,6 +387,11 @@
"sheetId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
"parameters": {
"spreadsheetId": {
"description": "The ID of the spreadsheet containing the sheet to copy.",
@@ -501,27 +407,146 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ]
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
+ "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
+ "id": "sheets.spreadsheets.sheets.copyTo",
+ "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
+ "request": {
+ "$ref": "CopySheetToAnotherSpreadsheetRequest"
+ }
}
}
}
+ },
+ "methods": {
+ "get": {
+ "id": "sheets.spreadsheets.get",
+ "path": "v4/spreadsheets/{spreadsheetId}",
+ "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The spreadsheet to request.",
+ "required": true,
+ "type": "string"
+ },
+ "ranges": {
+ "description": "The ranges to retrieve from the spreadsheet.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "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.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}"
+ },
+ "create": {
+ "path": "v4/spreadsheets",
+ "id": "sheets.spreadsheets.create",
+ "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
+ "request": {
+ "$ref": "Spreadsheet"
+ },
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {},
+ "flatPath": "v4/spreadsheets"
+ },
+ "batchUpdate": {
+ "response": {
+ "$ref": "BatchUpdateSpreadsheetResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The spreadsheet to apply the updates to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
+ "id": "sheets.spreadsheets.batchUpdate",
+ "request": {
+ "$ref": "BatchUpdateSpreadsheetRequest"
+ },
+ "description": "Applies one or more updates to the spreadsheet.\n\nEach request is validated before\nbeing applied. If any request is not valid then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how\nthey are applied. The replies will mirror the requests. For example,\nif you applied 4 updates and the 3rd one had a reply, then the\nresponse will have 2 empty replies, the actual reply, and another empty\nreply, in that order.\n\nDue to the collaborative nature of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exactly your changes after this completes,\nhowever it is guaranteed that the updates in the request will be\napplied together atomically. Your changes may be altered with respect to\ncollaborator changes. If there are no collaborators, the spreadsheet\nshould reflect your changes."
+ }
}
}
},
"parameters": {
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "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"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enumDescriptions": [
@@ -537,88 +562,2291 @@
"type": "string"
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "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"
+ "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": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "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"
- },
- "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": "v4",
"baseUrl": "https://sheets.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Reads and writes Google Sheets.",
"servicePath": "",
+ "description": "Reads and writes Google Sheets.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20170505",
- "documentationLink": "https://developers.google.com/sheets/",
"id": "sheets:v4",
+ "documentationLink": "https://developers.google.com/sheets/",
+ "revision": "20170602",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "CopyPasteRequest": {
- "description": "Copies data from the source to the destination.",
+ "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": {
+ "description": "Fills in more data based on existing data.",
+ "type": "object",
+ "properties": {
+ "useAlternateSeries": {
+ "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
+ "type": "boolean"
+ },
+ "sourceAndDestination": {
+ "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data.",
+ "$ref": "SourceAndDestination"
+ },
+ "range": {
+ "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "AutoFillRequest"
+ },
+ "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": {
+ "description": "The starting interpolation point.",
+ "$ref": "InterpolationPoint"
+ },
+ "maxpoint": {
+ "description": "The final interpolation point.",
+ "$ref": "InterpolationPoint"
+ },
+ "midpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "An optional midway interpolation point."
+ }
+ },
+ "id": "GradientRule"
+ },
+ "SetBasicFilterRequest": {
+ "properties": {
+ "filter": {
+ "description": "The filter to set.",
+ "$ref": "BasicFilter"
+ }
+ },
+ "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": {
+ "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"
+ }
+ },
+ "id": "InterpolationPoint"
+ },
+ "FindReplaceResponse": {
+ "description": "The result of the find/replace.",
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -\u003e `\"Googlo Shoots\"`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowsChanged": {
+ "description": "The number of rows changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetsChanged": {
+ "description": "The number of sheets changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "formulasChanged": {
+ "description": "The number of formula cells changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "valuesChanged": {
+ "description": "The number of non-formula cells changed.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "FindReplaceResponse"
+ },
+ "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"
+ },
+ "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": {
+ "description": "The result of updating a conditional format rule.",
+ "type": "object",
+ "properties": {
+ "oldIndex": {
+ "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newRule": {
+ "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"
+ },
+ "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"
+ },
+ "DuplicateSheetRequest": {
+ "description": "Duplicates the contents of a sheet.",
+ "type": "object",
+ "properties": {
+ "newSheetName": {
+ "description": "The name of the new sheet. If empty, a new name is chosen for you.",
+ "type": "string"
+ },
+ "sourceSheetId": {
+ "description": "The sheet to duplicate.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newSheetId": {
+ "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "insertSheetIndex": {
+ "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DuplicateSheetRequest"
+ },
+ "ExtendedValue": {
+ "properties": {
+ "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"
+ },
+ "numberValue": {
+ "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "ExtendedValue",
+ "description": "The kinds of value that a cell in a spreadsheet can have.",
+ "type": "object"
+ },
+ "BandedRange": {
+ "description": "A banded (alternating colors) range in a sheet.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range over which these properties are applied."
+ },
+ "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": {
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "clearedRanges": {
+ "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "id": "BatchClearValuesResponse"
+ },
+ "Spreadsheet": {
+ "description": "Resource that represents a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "AddChartRequest": {
+ "properties": {
+ "chart": {
+ "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a chart that already exists.)",
+ "$ref": "EmbeddedChart"
+ }
+ },
+ "id": "AddChartRequest",
+ "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": {
+ "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"
+ },
+ "TextFormat": {
+ "properties": {
+ "underline": {
+ "description": "True if the text is underlined.",
+ "type": "boolean"
+ },
+ "foregroundColor": {
+ "$ref": "Color",
+ "description": "The foreground color of the text."
+ },
+ "bold": {
+ "description": "True if the text is bold.",
+ "type": "boolean"
+ },
+ "fontFamily": {
+ "description": "The font family.",
+ "type": "string"
+ },
+ "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": {
+ "properties": {
+ "properties": {
+ "description": "The properties of the newly added sheet.",
+ "$ref": "SheetProperties"
+ }
+ },
+ "id": "AddSheetResponse",
+ "description": "The result of adding a sheet.",
+ "type": "object"
+ },
+ "AddFilterViewResponse": {
+ "description": "The result of adding a filter view.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "The newly added filter view.",
+ "$ref": "FilterView"
+ }
+ },
+ "id": "AddFilterViewResponse"
+ },
+ "IterativeCalculationSettings": {
+ "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",
+ "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
+ "type": "object"
+ },
+ "OverlayPosition": {
+ "description": "The location an object is overlaid on top of a grid.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "offsetXPixels": {
+ "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "OverlayPosition"
+ },
+ "SpreadsheetProperties": {
+ "description": "Properties of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "The title of the spreadsheet.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
+ "type": "string"
+ },
+ "iterativeCalculationSettings": {
+ "$ref": "IterativeCalculationSettings",
+ "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors."
+ },
+ "autoRecalc": {
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "Volatile functions are updated on every change.",
+ "Volatile functions are updated on every change and every minute.",
+ "Volatile functions are updated on every change and hourly."
+ ],
+ "enum": [
+ "RECALCULATION_INTERVAL_UNSPECIFIED",
+ "ON_CHANGE",
+ "MINUTE",
+ "HOUR"
+ ],
+ "description": "The amount of time to wait before volatile functions are recalculated.",
+ "type": "string"
+ },
+ "defaultFormat": {
+ "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only.",
+ "$ref": "CellFormat"
+ }
+ },
+ "id": "SpreadsheetProperties"
+ },
+ "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"
+ },
+ "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": {
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The dimensions to insert. Both the start and end indexes must be bounded."
+ },
+ "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",
+ "description": "Inserts rows or columns in a sheet at a particular index.",
+ "type": "object"
+ },
+ "UpdateSpreadsheetPropertiesRequest": {
+ "description": "Updates properties of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "SpreadsheetProperties",
+ "description": "The properties to update."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateSpreadsheetPropertiesRequest"
+ },
+ "ProtectedRange": {
+ "description": "A protected range.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection.",
+ "$ref": "Editors"
+ },
+ "description": {
+ "description": "The description of this protected range.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "ProtectedRange"
+ },
+ "BatchUpdateValuesRequest": {
+ "description": "The request for updating more than one range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "responseValueRenderOption": {
+ "enumDescriptions": [
+ "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+ "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+ "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+ ],
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string"
+ },
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
+ "type": "boolean"
+ },
+ "valueInputOption": {
+ "description": "How the input data should be interpreted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default input value. This value must not be used.",
+ "The values the user has entered will not be parsed and will be stored\nas-is.",
+ "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
+ ],
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ]
+ },
+ "data": {
+ "description": "The new values to apply to the spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ValueRange"
+ }
+ },
+ "responseDateTimeRenderOption": {
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
+ "type": "string",
+ "enumDescriptions": [
+ "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
+ "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
+ ],
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ]
+ }
+ },
+ "id": "BatchUpdateValuesRequest"
+ },
+ "DimensionProperties": {
+ "description": "Properties about a dimension.",
+ "type": "object",
+ "properties": {
+ "pixelSize": {
+ "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hiddenByFilter": {
+ "description": "True if this dimension is being filtered.\nThis field is read-only.",
+ "type": "boolean"
+ },
+ "hiddenByUser": {
+ "description": "True if this dimension is explicitly hidden.",
+ "type": "boolean"
+ }
+ },
+ "id": "DimensionProperties"
+ },
+ "DimensionRange": {
+ "description": "A range along a single dimension on a sheet.\nAll indexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side.",
+ "type": "object",
+ "properties": {
+ "dimension": {
+ "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"
+ },
+ "NamedRange": {
+ "description": "A named range.",
+ "type": "object",
+ "properties": {
+ "namedRangeId": {
+ "description": "The ID of the named range.",
+ "type": "string"
+ },
+ "range": {
+ "description": "The range this represents.",
+ "$ref": "GridRange"
+ },
+ "name": {
+ "description": "The name of the named range.",
+ "type": "string"
+ }
+ },
+ "id": "NamedRange"
+ },
+ "CutPasteRequest": {
+ "description": "Moves data from the source to the destination.",
"type": "object",
"properties": {
"source": {
+ "description": "The source data to cut.",
+ "$ref": "GridRange"
+ },
+ "pasteType": {
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ],
+ "enum": [
+ "PASTE_NORMAL",
+ "PASTE_VALUES",
+ "PASTE_FORMAT",
+ "PASTE_NO_BORDERS",
+ "PASTE_FORMULA",
+ "PASTE_DATA_VALIDATION",
+ "PASTE_CONDITIONAL_FORMATTING"
+ ],
+ "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
+ "type": "string"
+ },
+ "destination": {
+ "description": "The top-left coordinate where the data should be pasted.",
+ "$ref": "GridCoordinate"
+ }
+ },
+ "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": {
+ "$ref": "ChartData",
+ "description": "The data being visualized in this chart series."
+ },
+ "type": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.",
+ "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e."
+ ],
+ "enum": [
+ "BASIC_CHART_TYPE_UNSPECIFIED",
+ "BAR",
+ "LINE",
+ "AREA",
+ "COLUMN",
+ "SCATTER",
+ "COMBO"
+ ],
+ "description": "The type of this series. Valid only if the\nchartType is\nCOMBO.\nDifferent types will change the way the series is visualized.\nOnly LINE, AREA,\nand COLUMN are supported.",
+ "type": "string"
+ },
+ "targetAxis": {
+ "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ ],
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ]
+ }
+ },
+ "id": "BasicChartSeries"
+ },
+ "Borders": {
+ "properties": {
+ "right": {
+ "$ref": "Border",
+ "description": "The right border of the cell."
+ },
+ "bottom": {
+ "description": "The bottom border of the cell.",
+ "$ref": "Border"
+ },
+ "top": {
+ "description": "The top border of the cell.",
+ "$ref": "Border"
+ },
+ "left": {
+ "$ref": "Border",
+ "description": "The left border of the cell."
+ }
+ },
+ "id": "Borders",
+ "description": "The borders of the cell.",
+ "type": "object"
+ },
+ "AutoResizeDimensionsRequest": {
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
+ "type": "object",
+ "properties": {
+ "dimensions": {
+ "description": "The dimensions to automatically resize.\nOnly COLUMNS are supported.",
+ "$ref": "DimensionRange"
+ }
+ },
+ "id": "AutoResizeDimensionsRequest"
+ },
+ "UpdateBordersRequest": {
+ "description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.",
+ "type": "object",
+ "properties": {
+ "top": {
+ "description": "The border to put at the top of the range.",
+ "$ref": "Border"
+ },
+ "left": {
+ "description": "The border to put at the left of the range.",
+ "$ref": "Border"
+ },
+ "bottom": {
+ "description": "The border to put at the bottom of the range.",
+ "$ref": "Border"
+ },
+ "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": {
"$ref": "GridRange",
- "description": "The source range to copy."
+ "description": "The range whose borders should be updated."
+ },
+ "innerHorizontal": {
+ "description": "The horizontal border to put within the range.",
+ "$ref": "Border"
+ }
+ },
+ "id": "UpdateBordersRequest"
+ },
+ "CellFormat": {
+ "description": "The format of a cell.",
+ "type": "object",
+ "properties": {
+ "backgroundColor": {
+ "description": "The background color of the cell.",
+ "$ref": "Color"
+ },
+ "padding": {
+ "$ref": "Padding",
+ "description": "The padding of the cell."
+ },
+ "verticalAlignment": {
+ "enumDescriptions": [
+ "The vertical alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the top of the cell.",
+ "The text is explicitly aligned to the middle of the cell.",
+ "The text is explicitly aligned to the bottom of the cell."
+ ],
+ "enum": [
+ "VERTICAL_ALIGN_UNSPECIFIED",
+ "TOP",
+ "MIDDLE",
+ "BOTTOM"
+ ],
+ "description": "The vertical alignment of the value in the cell.",
+ "type": "string"
+ },
+ "borders": {
+ "$ref": "Borders",
+ "description": "The borders of the cell."
+ },
+ "textDirection": {
+ "enumDescriptions": [
+ "The text direction is not specified. Do not use this.",
+ "The text direction of left-to-right was set by the user.",
+ "The text direction of right-to-left was set by the user."
+ ],
+ "enum": [
+ "TEXT_DIRECTION_UNSPECIFIED",
+ "LEFT_TO_RIGHT",
+ "RIGHT_TO_LEFT"
+ ],
+ "description": "The direction of the text in the cell.",
+ "type": "string"
+ },
+ "textRotation": {
+ "description": "The rotation applied to text in a cell",
+ "$ref": "TextRotation"
+ },
+ "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"
+ },
+ "hyperlinkDisplayType": {
+ "description": "How a hyperlink, if it exists, should be displayed in the cell.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value: the hyperlink is rendered. Do not use this.",
+ "A hyperlink should be explicitly rendered.",
+ "A hyperlink should not be rendered."
+ ],
+ "enum": [
+ "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
+ "LINKED",
+ "PLAIN_TEXT"
+ ]
+ },
+ "horizontalAlignment": {
+ "enumDescriptions": [
+ "The horizontal alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the left of the cell.",
+ "The text is explicitly aligned to the center of the cell.",
+ "The text is explicitly aligned to the right of the cell."
+ ],
+ "enum": [
+ "HORIZONTAL_ALIGN_UNSPECIFIED",
+ "LEFT",
+ "CENTER",
+ "RIGHT"
+ ],
+ "description": "The horizontal alignment of the value in the cell.",
+ "type": "string"
+ },
+ "textFormat": {
+ "$ref": "TextFormat",
+ "description": "The format of the text in the cell (unless overridden by a format run)."
+ }
+ },
+ "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.",
+ "type": "string"
+ },
+ "clearedRange": {
+ "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
+ "type": "string"
+ }
+ },
+ "id": "ClearValuesResponse"
+ },
+ "DeleteConditionalFormatRuleRequest": {
+ "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "The zero-based index of the rule to be deleted.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet the rule is being deleted from.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteConditionalFormatRuleRequest"
+ },
+ "DeleteNamedRangeRequest": {
+ "description": "Removes the named range with the given ID from the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "namedRangeId": {
+ "description": "The ID of the named range to delete.",
+ "type": "string"
+ }
+ },
+ "id": "DeleteNamedRangeRequest"
+ },
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "BatchGetValuesResponse"
+ },
+ "UpdateBandingRequest": {
+ "description": "Updates properties of the supplied banded range.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `bandedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "bandedRange": {
+ "description": "The banded range to update with the new properties.",
+ "$ref": "BandedRange"
+ }
+ },
+ "id": "UpdateBandingRequest"
+ },
+ "Color": {
+ "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
+ "type": "object",
+ "properties": {
+ "red": {
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "green": {
+ "description": "The amount of green in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "blue": {
+ "description": "The amount of blue in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "alpha": {
+ "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "Color"
+ },
+ "PivotGroup": {
+ "description": "A single grouping (either row or column) in a pivot table.",
+ "type": "object",
+ "properties": {
+ "sourceColumnOffset": {
+ "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "showTotals": {
+ "description": "True if the pivot table should include the totals for this grouping.",
+ "type": "boolean"
+ },
+ "valueMetadata": {
+ "description": "Metadata about values in the grouping.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotGroupValueMetadata"
+ }
+ },
+ "sortOrder": {
+ "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."
+ ]
+ },
+ "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"
+ },
+ "PivotTable": {
+ "properties": {
+ "criteria": {
+ "description": "An optional mapping of filters per source column offset.\n\nThe filters will be applied before aggregating data into the pivot table.\nThe map's key is the column offset of the source range that you want to\nfilter, and the value is the criteria for that column.\n\nFor example, if the source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, whereas the key `1` is for column `D`.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "PivotFilterCriteria"
+ }
+ },
+ "rows": {
+ "description": "Each row grouping in the pivot table.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotGroup"
+ }
+ },
+ "valueLayout": {
+ "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
+ "type": "string",
+ "enumDescriptions": [
+ "Values are laid out horizontally (as columns).",
+ "Values are laid out vertically (as rows)."
+ ],
+ "enum": [
+ "HORIZONTAL",
+ "VERTICAL"
+ ]
+ },
+ "columns": {
+ "description": "Each column grouping in the pivot table.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotGroup"
+ }
+ },
+ "values": {
+ "description": "A list of values to include in the pivot table.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotValue"
+ }
+ },
+ "source": {
+ "$ref": "GridRange",
+ "description": "The range the pivot table is reading data from."
+ }
+ },
+ "id": "PivotTable",
+ "description": "A pivot table.",
+ "type": "object"
+ },
+ "ChartSourceRange": {
+ "description": "Source ranges for a chart.",
+ "type": "object",
+ "properties": {
+ "sources": {
+ "description": "The ranges of data for a series or domain.\nExactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source range, then the source\nrange at a given offset must be contiguous across the domain and series.\n\nFor example, these are valid configurations:\n\n domain sources: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sources: C1:C5, E10:E12",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ }
+ },
+ "id": "ChartSourceRange"
+ },
+ "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": {
+ "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",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "values": {
+ "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "ValueRange"
+ },
+ "AppendCellsRequest": {
+ "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
+ "type": "object",
+ "properties": {
+ "rows": {
+ "description": "The data to append.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "fields": {
+ "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "sheetId": {
+ "description": "The sheet ID to append the data to.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "AppendCellsRequest"
+ },
+ "AddBandingRequest": {
+ "description": "Adds a new banded range to the spreadsheet.",
+ "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"
+ }
+ },
+ "id": "AddBandingRequest"
+ },
+ "Response": {
+ "description": "A single response from an update.",
+ "type": "object",
+ "properties": {
+ "addFilterView": {
+ "description": "A reply from adding a filter view.",
+ "$ref": "AddFilterViewResponse"
+ },
+ "addBanding": {
+ "$ref": "AddBandingResponse",
+ "description": "A reply from adding a banded range."
+ },
+ "addProtectedRange": {
+ "$ref": "AddProtectedRangeResponse",
+ "description": "A reply from adding a protected range."
+ },
+ "duplicateSheet": {
+ "$ref": "DuplicateSheetResponse",
+ "description": "A reply from duplicating a sheet."
+ },
+ "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": {
+ "description": "A reply from duplicating a filter view.",
+ "$ref": "DuplicateFilterViewResponse"
+ },
+ "addChart": {
+ "$ref": "AddChartResponse",
+ "description": "A reply from adding a chart."
+ },
+ "findReplace": {
+ "description": "A reply from doing a find/replace.",
+ "$ref": "FindReplaceResponse"
+ },
+ "addSheet": {
+ "$ref": "AddSheetResponse",
+ "description": "A reply from adding a sheet."
+ },
+ "updateConditionalFormatRule": {
+ "description": "A reply from updating a conditional format rule.",
+ "$ref": "UpdateConditionalFormatRuleResponse"
+ },
+ "addNamedRange": {
+ "$ref": "AddNamedRangeResponse",
+ "description": "A reply from adding a named range."
+ }
+ },
+ "id": "Response"
+ },
+ "InsertRangeRequest": {
+ "properties": {
+ "shiftDimension": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ]
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to insert new cells into."
+ }
+ },
+ "id": "InsertRangeRequest",
+ "description": "Inserts cells into a range, shifting the existing cells over or down.",
+ "type": "object"
+ },
+ "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": {
+ "format": {
+ "description": "The format of this run. Absent values inherit the cell's format.",
+ "$ref": "TextFormat"
+ },
+ "startIndex": {
+ "description": "The character index where this run starts.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TextFormatRun"
+ },
+ "EmbeddedChart": {
+ "description": "A chart embedded in a sheet.",
+ "type": "object",
+ "properties": {
+ "chartId": {
+ "description": "The ID of the chart.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "position": {
+ "$ref": "EmbeddedObjectPosition",
+ "description": "The position of the chart."
+ },
+ "spec": {
+ "$ref": "ChartSpec",
+ "description": "The specification of the chart."
+ }
+ },
+ "id": "EmbeddedChart"
+ },
+ "AddNamedRangeResponse": {
+ "description": "The result of adding a named range.",
+ "type": "object",
+ "properties": {
+ "namedRange": {
+ "$ref": "NamedRange",
+ "description": "The named range to add."
+ }
+ },
+ "id": "AddNamedRangeResponse"
+ },
+ "RowData": {
+ "description": "Data about each cell in a row.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "The values in the row, one per column.",
+ "type": "array",
+ "items": {
+ "$ref": "CellData"
+ }
+ }
+ },
+ "id": "RowData"
+ },
+ "Border": {
+ "description": "A border along a cell.",
+ "type": "object",
+ "properties": {
+ "width": {
+ "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "style": {
+ "enumDescriptions": [
+ "The style is not specified. Do not use this.",
+ "The border is dotted.",
+ "The border is dashed.",
+ "The border is a thin solid line.",
+ "The border is a medium solid line.",
+ "The border is a thick solid line.",
+ "No border.\nUsed only when updating a border in order to erase it.",
+ "The border is two solid lines."
+ ],
+ "enum": [
+ "STYLE_UNSPECIFIED",
+ "DOTTED",
+ "DASHED",
+ "SOLID",
+ "SOLID_MEDIUM",
+ "SOLID_THICK",
+ "NONE",
+ "DOUBLE"
+ ],
+ "description": "The style of the border.",
+ "type": "string"
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "The color of the border."
+ }
+ },
+ "id": "Border"
+ },
+ "GridData": {
+ "description": "Data in the grid, as well as metadata about the dimensions.",
+ "type": "object",
+ "properties": {
+ "startColumn": {
+ "description": "The first column this GridData refers to, zero-based.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowMetadata": {
+ "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionProperties"
+ }
+ },
+ "rowData": {
+ "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "startRow": {
+ "description": "The first row this GridData refers to, zero-based.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "columnMetadata": {
+ "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionProperties"
+ }
+ }
+ },
+ "id": "GridData"
+ },
+ "UpdateNamedRangeRequest": {
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "namedRange": {
+ "$ref": "NamedRange",
+ "description": "The named range to update with the new properties."
+ }
+ },
+ "id": "UpdateNamedRangeRequest",
+ "description": "Updates properties of the named range with the specified\nnamedRangeId.",
+ "type": "object"
+ },
+ "FindReplaceRequest": {
+ "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
+ "type": "object",
+ "properties": {
+ "replacement": {
+ "description": "The value to use as the replacement.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to find/replace over."
+ },
+ "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"
+ },
+ "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": {
+ "description": "The value to search.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "FindReplaceRequest"
+ },
+ "AddSheetRequest": {
+ "description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmbeddedObjectPosition.newSheet.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$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": {
+ "rows": {
+ "description": "The data to write.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "fields": {
+ "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "start": {
+ "$ref": "GridCoordinate",
+ "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written."
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
+ }
+ },
+ "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"
+ },
+ "DeleteRangeRequest": {
+ "properties": {
+ "shiftDimension": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ]
+ },
+ "range": {
+ "description": "The range of cells to delete.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "DeleteRangeRequest",
+ "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": {
+ "rowIndex": {
+ "description": "The row index of the coordinate.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "columnIndex": {
+ "description": "The column index of the coordinate.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet this coordinate is on.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GridCoordinate"
+ },
+ "UpdateSheetPropertiesRequest": {
+ "properties": {
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties to update."
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateSheetPropertiesRequest",
+ "description": "Updates properties of the sheet with the specified\nsheetId.",
+ "type": "object"
+ },
+ "GridProperties": {
+ "description": "Properties of a grid.",
+ "type": "object",
+ "properties": {
+ "rowCount": {
+ "description": "The number of rows in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "frozenRowCount": {
+ "description": "The number of rows that are frozen in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hideGridlines": {
+ "description": "True if the grid isn't showing gridlines in the UI.",
+ "type": "boolean"
+ },
+ "columnCount": {
+ "description": "The number of columns in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "frozenColumnCount": {
+ "description": "The number of columns that are frozen in the grid.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GridProperties"
+ },
+ "UnmergeCellsRequest": {
+ "description": "Unmerges cells in the given range.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge."
+ }
+ },
+ "id": "UnmergeCellsRequest"
+ },
+ "SortSpec": {
+ "properties": {
+ "dimensionIndex": {
+ "description": "The dimension the sort should be applied to.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sortOrder": {
+ "description": "The order data should be sorted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ],
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ]
+ }
+ },
+ "id": "SortSpec",
+ "description": "A sort order associated with a specific column or row.",
+ "type": "object"
+ },
+ "Sheet": {
+ "description": "A sheet in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "basicFilter": {
+ "$ref": "BasicFilter",
+ "description": "The filter on this sheet, if any."
+ },
+ "merges": {
+ "description": "The ranges that are merged together.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ },
+ "data": {
+ "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
+ "type": "array",
+ "items": {
+ "$ref": "GridData"
+ }
+ },
+ "bandedRanges": {
+ "description": "The banded (i.e. alternating colors) ranges on this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "BandedRange"
+ }
+ },
+ "charts": {
+ "description": "The specifications of every chart on this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "EmbeddedChart"
+ }
+ },
+ "properties": {
+ "description": "The properties of the sheet.",
+ "$ref": "SheetProperties"
+ },
+ "filterViews": {
+ "description": "The filter views in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "FilterView"
+ }
+ },
+ "conditionalFormats": {
+ "description": "The conditional format rules in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ConditionalFormatRule"
+ }
+ },
+ "protectedRanges": {
+ "description": "The protected ranges in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ProtectedRange"
+ }
+ }
+ },
+ "id": "Sheet"
+ },
+ "UpdateEmbeddedObjectPositionResponse": {
+ "description": "The result of updating an embedded object's position.",
+ "type": "object",
+ "properties": {
+ "position": {
+ "$ref": "EmbeddedObjectPosition",
+ "description": "The new position of the embedded object."
+ }
+ },
+ "id": "UpdateEmbeddedObjectPositionResponse"
+ },
+ "BooleanRule": {
+ "description": "A rule that may or may not match, depending on the condition.",
+ "type": "object",
+ "properties": {
+ "format": {
+ "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color.",
+ "$ref": "CellFormat"
+ },
+ "condition": {
+ "$ref": "BooleanCondition",
+ "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
+ }
+ },
+ "id": "BooleanRule"
+ },
+ "FilterCriteria": {
+ "description": "Criteria for showing/hiding rows in a filter or filter view.",
+ "type": "object",
+ "properties": {
+ "hiddenValues": {
+ "description": "Values that should be hidden.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "condition": {
+ "$ref": "BooleanCondition",
+ "description": "A condition that must be true for values to be shown.\n(This does not override hiddenValues -- if a value is listed there,\n it will still be hidden.)"
+ }
+ },
+ "id": "FilterCriteria"
+ },
+ "PivotGroupValueMetadata": {
+ "description": "Metadata about a value in a pivot grouping.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "$ref": "ExtendedValue",
+ "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)"
+ },
+ "collapsed": {
+ "description": "True if the data corresponding to the value is collapsed.",
+ "type": "boolean"
+ }
+ },
+ "id": "PivotGroupValueMetadata"
+ },
+ "Editors": {
+ "description": "The editors of a protected range.",
+ "type": "object",
+ "properties": {
+ "users": {
+ "description": "The email addresses of users with edit access to the protected range.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "groups": {
+ "description": "The email addresses of groups with edit access to the protected range.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "domainUsersCanEdit": {
+ "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.",
+ "type": "boolean"
+ }
+ },
+ "id": "Editors"
+ },
+ "UpdateConditionalFormatRuleRequest": {
+ "properties": {
+ "newIndex": {
+ "description": "The zero-based new index the rule should end up at.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule that should replace the rule at the given index."
+ },
+ "index": {
+ "description": "The zero-based index of the rule that should be replaced or moved.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
+ "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"
+ },
+ "DataValidationRule": {
+ "description": "A data validation rule.",
+ "type": "object",
+ "properties": {
+ "condition": {
+ "description": "The condition that data in the cell must match.",
+ "$ref": "BooleanCondition"
+ },
+ "showCustomUi": {
+ "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
+ "type": "boolean"
+ },
+ "strict": {
+ "description": "True if invalid data should be rejected.",
+ "type": "boolean"
+ },
+ "inputMessage": {
+ "description": "A message to show the user when adding data to the cell.",
+ "type": "string"
+ }
+ },
+ "id": "DataValidationRule"
+ },
+ "PasteDataRequest": {
+ "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
+ "type": "object",
+ "properties": {
+ "html": {
+ "description": "True if the data is HTML.",
+ "type": "boolean"
+ },
+ "coordinate": {
+ "$ref": "GridCoordinate",
+ "description": "The coordinate at which the data should start being inserted."
+ },
+ "data": {
+ "description": "The data to insert.",
+ "type": "string"
+ },
+ "delimiter": {
+ "description": "The delimiter in the data.",
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "PASTE_NORMAL",
+ "PASTE_VALUES",
+ "PASTE_FORMAT",
+ "PASTE_NO_BORDERS",
+ "PASTE_FORMULA",
+ "PASTE_DATA_VALIDATION",
+ "PASTE_CONDITIONAL_FORMATTING"
+ ],
+ "description": "How the data should be pasted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ]
+ }
+ },
+ "id": "PasteDataRequest"
+ },
+ "AppendDimensionRequest": {
+ "description": "Appends rows or columns to the end of a sheet.",
+ "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": "Whether rows or columns should be appended.",
+ "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.",
+ "type": "object",
+ "properties": {
+ "namedRange": {
+ "description": "The named range to add. The namedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)",
+ "$ref": "NamedRange"
+ }
+ },
+ "id": "AddNamedRangeRequest"
+ },
+ "UpdateEmbeddedObjectPositionRequest": {
+ "properties": {
+ "newPosition": {
+ "$ref": "EmbeddedObjectPosition",
+ "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you."
+ },
+ "fields": {
+ "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The ID of the object to moved.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateEmbeddedObjectPositionRequest",
+ "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
+ "type": "object"
+ },
+ "TextRotation": {
+ "properties": {
+ "angle": {
+ "description": "The angle between the standard orientation and the desired orientation.\nMeasured in degrees. Valid values are between -90 and 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNote: For LTR text direction positive angles are in the counterclockwise\ndirection, whereas for RTL they are in the clockwise direction",
+ "format": "int32",
+ "type": "integer"
+ },
+ "vertical": {
+ "description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
+ "type": "boolean"
+ }
+ },
+ "id": "TextRotation",
+ "description": "The rotation applied to text in a cell.",
+ "type": "object"
+ },
+ "PieChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
+ "type": "object",
+ "properties": {
+ "series": {
+ "$ref": "ChartData",
+ "description": "The data that covers the one and only series of the pie chart."
+ },
+ "legendPosition": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "Each pie slice has a label attached to it."
+ ],
+ "enum": [
+ "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "LABELED_LEGEND"
+ ],
+ "description": "Where the legend of the pie chart should be drawn.",
+ "type": "string"
+ },
+ "pieHole": {
+ "description": "The size of the hole in the pie chart.",
+ "format": "double",
+ "type": "number"
+ },
+ "domain": {
+ "$ref": "ChartData",
+ "description": "The data that covers the domain of the pie chart."
+ },
+ "threeDimensional": {
+ "description": "True if the pie is three dimensional.",
+ "type": "boolean"
+ }
+ },
+ "id": "PieChartSpec"
+ },
+ "UpdateFilterViewRequest": {
+ "description": "Updates properties of the filter view.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "The new properties of the filter view.",
+ "$ref": "FilterView"
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `filter` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateFilterViewRequest"
+ },
+ "ConditionalFormatRule": {
+ "properties": {
+ "ranges": {
+ "description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ },
+ "gradientRule": {
+ "description": "The formatting will vary based on the gradients in the rule.",
+ "$ref": "GradientRule"
+ },
+ "booleanRule": {
+ "description": "The formatting is either \"on\" or \"off\" according to the rule.",
+ "$ref": "BooleanRule"
+ }
+ },
+ "id": "ConditionalFormatRule",
+ "description": "A rule describing a conditional format.",
+ "type": "object"
+ },
+ "CopyPasteRequest": {
+ "properties": {
+ "source": {
+ "description": "The source range to copy.",
+ "$ref": "GridRange"
},
"pasteType": {
"description": "What kind of data to paste.",
@@ -643,31 +2871,35 @@
]
},
"destination": {
- "$ref": "GridRange",
- "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range)."
+ "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range).",
+ "$ref": "GridRange"
},
"pasteOrientation": {
+ "enumDescriptions": [
+ "Paste normally.",
+ "Paste transposed, where all rows become columns and vice versa."
+ ],
"enum": [
"NORMAL",
"TRANSPOSE"
],
"description": "How that data should be oriented when pasting.",
- "type": "string",
- "enumDescriptions": [
- "Paste normally.",
- "Paste transposed, where all rows become columns and vice versa."
- ]
+ "type": "string"
}
},
- "id": "CopyPasteRequest"
+ "id": "CopyPasteRequest",
+ "description": "Copies data from the source to the destination.",
+ "type": "object"
},
"Request": {
- "description": "A single kind of update to apply to a spreadsheet.",
- "type": "object",
"properties": {
+ "updateSpreadsheetProperties": {
+ "description": "Updates the spreadsheet's properties.",
+ "$ref": "UpdateSpreadsheetPropertiesRequest"
+ },
"deleteEmbeddedObject": {
- "$ref": "DeleteEmbeddedObjectRequest",
- "description": "Deletes an embedded object (e.g, chart, image) in a sheet."
+ "description": "Deletes an embedded object (e.g, chart, image) in a sheet.",
+ "$ref": "DeleteEmbeddedObjectRequest"
},
"updateFilterView": {
"$ref": "UpdateFilterViewRequest",
@@ -677,17 +2909,17 @@
"description": "Adds a new banded range",
"$ref": "AddBandingRequest"
},
- "autoResizeDimensions": {
- "$ref": "AutoResizeDimensionsRequest",
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
- },
"appendCells": {
"$ref": "AppendCellsRequest",
"description": "Appends cells after the last row with data in a sheet."
},
+ "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."
+ "description": "Cuts data from one area and pastes it to another.",
+ "$ref": "CutPasteRequest"
},
"mergeCells": {
"description": "Merges cells together.",
@@ -701,25 +2933,25 @@
"$ref": "UpdateSheetPropertiesRequest",
"description": "Updates a sheet's properties."
},
- "autoFill": {
- "description": "Automatically fills in more data based on existing data.",
- "$ref": "AutoFillRequest"
- },
"deleteDimension": {
"$ref": "DeleteDimensionRequest",
"description": "Deletes rows or columns in a sheet."
},
+ "autoFill": {
+ "$ref": "AutoFillRequest",
+ "description": "Automatically fills in more data based on existing data."
+ },
"sortRange": {
- "description": "Sorts data in a range.",
- "$ref": "SortRangeRequest"
+ "$ref": "SortRangeRequest",
+ "description": "Sorts data in a range."
},
"deleteProtectedRange": {
"description": "Deletes a protected range.",
"$ref": "DeleteProtectedRangeRequest"
},
"duplicateFilterView": {
- "description": "Duplicates a filter view.",
- "$ref": "DuplicateFilterViewRequest"
+ "$ref": "DuplicateFilterViewRequest",
+ "description": "Duplicates a filter view."
},
"addChart": {
"$ref": "AddChartRequest",
@@ -729,30 +2961,30 @@
"$ref": "FindReplaceRequest",
"description": "Finds and replaces occurrences of some text with other text."
},
- "updateChartSpec": {
- "description": "Updates a chart's specifications.",
- "$ref": "UpdateChartSpecRequest"
- },
"textToColumns": {
"$ref": "TextToColumnsRequest",
"description": "Converts a column of text into many columns of text."
},
+ "updateChartSpec": {
+ "$ref": "UpdateChartSpecRequest",
+ "description": "Updates a chart's specifications."
+ },
+ "addSheet": {
+ "description": "Adds a sheet.",
+ "$ref": "AddSheetRequest"
+ },
"updateProtectedRange": {
"$ref": "UpdateProtectedRangeRequest",
"description": "Updates a protected range."
},
- "addSheet": {
- "$ref": "AddSheetRequest",
- "description": "Adds a sheet."
- },
- "deleteFilterView": {
- "$ref": "DeleteFilterViewRequest",
- "description": "Deletes a filter view from a sheet."
- },
"copyPaste": {
"$ref": "CopyPasteRequest",
"description": "Copies data from one area and pastes it to another."
},
+ "deleteFilterView": {
+ "description": "Deletes a filter view from a sheet.",
+ "$ref": "DeleteFilterViewRequest"
+ },
"insertDimension": {
"description": "Inserts new rows or columns in a sheet.",
"$ref": "InsertDimensionRequest"
@@ -766,48 +2998,48 @@
"$ref": "DeleteBandingRequest"
},
"addFilterView": {
- "$ref": "AddFilterViewRequest",
- "description": "Adds a filter view."
- },
- "updateBorders": {
- "description": "Updates the borders in a range of cells.",
- "$ref": "UpdateBordersRequest"
+ "description": "Adds a filter view.",
+ "$ref": "AddFilterViewRequest"
},
"setDataValidation": {
"description": "Sets data validation for one or more cells.",
"$ref": "SetDataValidationRequest"
},
- "deleteConditionalFormatRule": {
- "description": "Deletes an existing conditional format rule.",
- "$ref": "DeleteConditionalFormatRuleRequest"
+ "updateBorders": {
+ "$ref": "UpdateBordersRequest",
+ "description": "Updates the borders in a range of cells."
},
- "repeatCell": {
- "description": "Repeats a single cell across a range.",
- "$ref": "RepeatCellRequest"
+ "deleteConditionalFormatRule": {
+ "$ref": "DeleteConditionalFormatRuleRequest",
+ "description": "Deletes an existing conditional format rule."
},
"clearBasicFilter": {
"$ref": "ClearBasicFilterRequest",
"description": "Clears the basic filter on a sheet."
},
+ "repeatCell": {
+ "$ref": "RepeatCellRequest",
+ "description": "Repeats a single cell across a range."
+ },
"appendDimension": {
- "description": "Appends dimensions to the end of a sheet.",
- "$ref": "AppendDimensionRequest"
+ "$ref": "AppendDimensionRequest",
+ "description": "Appends dimensions to the end of a sheet."
},
"updateConditionalFormatRule": {
- "description": "Updates an existing conditional format rule.",
- "$ref": "UpdateConditionalFormatRuleRequest"
+ "$ref": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates an existing conditional format rule."
},
"insertRange": {
- "description": "Inserts new cells in a sheet, shifting the existing cells.",
- "$ref": "InsertRangeRequest"
+ "$ref": "InsertRangeRequest",
+ "description": "Inserts new cells in a sheet, shifting the existing cells."
},
"moveDimension": {
"description": "Moves rows or columns to another location in a sheet.",
"$ref": "MoveDimensionRequest"
},
"updateBanding": {
- "description": "Updates a banded range",
- "$ref": "UpdateBandingRequest"
+ "$ref": "UpdateBandingRequest",
+ "description": "Updates a banded range"
},
"addProtectedRange": {
"$ref": "AddProtectedRangeRequest",
@@ -818,16 +3050,16 @@
"description": "Deletes a named range."
},
"duplicateSheet": {
- "$ref": "DuplicateSheetRequest",
- "description": "Duplicates a sheet."
+ "description": "Duplicates a sheet.",
+ "$ref": "DuplicateSheetRequest"
},
"deleteSheet": {
- "description": "Deletes a sheet.",
- "$ref": "DeleteSheetRequest"
+ "$ref": "DeleteSheetRequest",
+ "description": "Deletes a sheet."
},
"unmergeCells": {
- "$ref": "UnmergeCellsRequest",
- "description": "Unmerges merged cells."
+ "description": "Unmerges merged cells.",
+ "$ref": "UnmergeCellsRequest"
},
"updateEmbeddedObjectPosition": {
"description": "Updates an embedded object's (e.g. chart, image) position.",
@@ -838,35 +3070,31 @@
"description": "Updates dimensions' properties."
},
"pasteData": {
- "description": "Pastes data (HTML or delimited) into a sheet.",
- "$ref": "PasteDataRequest"
+ "$ref": "PasteDataRequest",
+ "description": "Pastes data (HTML or delimited) into a sheet."
},
"setBasicFilter": {
"description": "Sets the basic filter on a sheet.",
"$ref": "SetBasicFilterRequest"
},
"addConditionalFormatRule": {
- "$ref": "AddConditionalFormatRuleRequest",
- "description": "Adds a new conditional format rule."
+ "description": "Adds a new conditional format rule.",
+ "$ref": "AddConditionalFormatRuleRequest"
+ },
+ "updateCells": {
+ "description": "Updates many cells at once.",
+ "$ref": "UpdateCellsRequest"
},
"addNamedRange": {
"$ref": "AddNamedRangeRequest",
"description": "Adds a named range."
- },
- "updateCells": {
- "$ref": "UpdateCellsRequest",
- "description": "Updates many cells at once."
- },
- "updateSpreadsheetProperties": {
- "$ref": "UpdateSpreadsheetPropertiesRequest",
- "description": "Updates the spreadsheet's properties."
}
},
- "id": "Request"
+ "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.",
- "type": "object",
"properties": {
"type": {
"enumDescriptions": [
@@ -942,7 +3170,9 @@
}
}
},
- "id": "BooleanCondition"
+ "id": "BooleanCondition",
+ "description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters.",
+ "type": "object"
},
"GridRange": {
"description": "A range on a sheet.\nAll indexes are zero-based.\nIndexes are half open, e.g the start index is inclusive\nand the end index is exclusive -- [start_index, end_index).\nMissing indexes indicate the range is unbounded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `Sheet1!A1:A1 == sheet_id: 0,\n start_row_index: 0, end_row_index: 1,\n start_column_index: 0, end_column_index: 1`\n\n `Sheet1!A3:B4 == sheet_id: 0,\n start_row_index: 2, end_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A:B == sheet_id: 0,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A5:B == sheet_id: 0,\n start_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1 == sheet_id:0`\n\nThe start index must always be less than or equal to the end index.\nIf the start index equals the end index, then the range is empty.\nEmpty ranges are typically not meaningful and are usually rendered in the\nUI as `#REF!`.",
@@ -977,8 +3207,6 @@
"id": "GridRange"
},
"BasicChartSpec": {
- "description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
- "type": "object",
"properties": {
"headerCount": {
"description": "The number of rows or columns in the data that are \"headers\".\nIf not set, Google Sheets will guess how many rows are headers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis title\n inferred from the header values.)",
@@ -993,8 +3221,6 @@
}
},
"chartType": {
- "description": "The type of the chart.",
- "type": "string",
"enumDescriptions": [
"Default value, do not use.",
"A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
@@ -1012,7 +3238,9 @@
"COLUMN",
"SCATTER",
"COMBO"
- ]
+ ],
+ "description": "The type of the chart.",
+ "type": "string"
},
"series": {
"description": "The data this chart is visualizing.",
@@ -1022,6 +3250,8 @@
}
},
"legendPosition": {
+ "description": "The position of the chart legend.",
+ "type": "string",
"enumDescriptions": [
"Default value, do not use.",
"The legend is rendered on the bottom of the chart.",
@@ -1037,9 +3267,7 @@
"RIGHT_LEGEND",
"TOP_LEGEND",
"NO_LEGEND"
- ],
- "description": "The position of the chart legend.",
- "type": "string"
+ ]
},
"domains": {
"description": "The domain of data this is charting.\nOnly a single domain is supported.",
@@ -1049,26 +3277,26 @@
}
}
},
- "id": "BasicChartSpec"
+ "id": "BasicChartSpec",
+ "description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
+ "type": "object"
},
"SetDataValidationRequest": {
+ "description": "Sets a data validation rule to every cell in the range.\nTo clear validation in a range, call this with no rule specified.",
"type": "object",
"properties": {
"rule": {
- "$ref": "DataValidationRule",
- "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range."
+ "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range.",
+ "$ref": "DataValidationRule"
},
"range": {
- "$ref": "GridRange",
- "description": "The range the data validation rule should apply to."
+ "description": "The range the data validation rule should apply to.",
+ "$ref": "GridRange"
}
},
- "id": "SetDataValidationRequest",
- "description": "Sets a data validation rule to every cell in the range.\nTo clear validation in a range, call this with no rule specified."
+ "id": "SetDataValidationRequest"
},
"CellData": {
- "description": "Data about a specific cell.",
- "type": "object",
"properties": {
"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.",
@@ -1090,16 +3318,16 @@
"$ref": "PivotTable"
},
"userEnteredFormat": {
- "description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format.",
- "$ref": "CellFormat"
+ "$ref": "CellFormat",
+ "description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format."
},
"effectiveFormat": {
- "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only.",
- "$ref": "CellFormat"
+ "$ref": "CellFormat",
+ "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only."
},
"note": {
- "type": "string",
- "description": "Any note on the cell."
+ "description": "Any note on the cell.",
+ "type": "string"
},
"userEnteredValue": {
"$ref": "ExtendedValue",
@@ -1114,10 +3342,11 @@
"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."
}
},
- "id": "CellData"
+ "id": "CellData",
+ "description": "Data about a specific cell.",
+ "type": "object"
},
"BatchUpdateSpreadsheetRequest": {
- "type": "object",
"properties": {
"includeSpreadsheetInResponse": {
"description": "Determines if the update response should include the spreadsheet\nresource.",
@@ -1143,17 +3372,44 @@
}
},
"id": "BatchUpdateSpreadsheetRequest",
- "description": "The request for updating any aspect of a spreadsheet."
+ "description": "The request for updating any aspect of a spreadsheet.",
+ "type": "object"
+ },
+ "BasicChartAxis": {
+ "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
+ "type": "object",
+ "properties": {
+ "position": {
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
+ "description": "The position of this axis.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ ]
+ },
+ "title": {
+ "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
+ "type": "string"
+ },
+ "format": {
+ "$ref": "TextFormat",
+ "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
+ }
+ },
+ "id": "BasicChartAxis"
},
"Padding": {
"description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
"type": "object",
"properties": {
- "bottom": {
- "description": "The bottom padding of the cell.",
- "format": "int32",
- "type": "integer"
- },
"top": {
"description": "The top padding of the cell.",
"format": "int32",
@@ -1168,74 +3424,48 @@
"description": "The right padding of the cell.",
"format": "int32",
"type": "integer"
+ },
+ "bottom": {
+ "description": "The bottom padding of the cell.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "Padding"
},
- "BasicChartAxis": {
- "type": "object",
- "properties": {
- "position": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
- "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
- "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
- ],
- "enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
- ],
- "description": "The position of this axis.",
- "type": "string"
- },
- "title": {
- "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
- "type": "string"
- },
- "format": {
- "$ref": "TextFormat",
- "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
- }
- },
- "id": "BasicChartAxis",
- "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position."
- },
"DeleteDimensionRequest": {
+ "description": "Deletes the dimensions from the sheet.",
+ "type": "object",
"properties": {
"range": {
"$ref": "DimensionRange",
"description": "The dimensions to delete from the sheet."
}
},
- "id": "DeleteDimensionRequest",
- "description": "Deletes the dimensions from the sheet.",
- "type": "object"
+ "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": {
+ "description": "The ID of the chart to update.",
+ "format": "int32",
+ "type": "integer"
+ },
"spec": {
"$ref": "ChartSpec",
"description": "The specification to apply to the chart."
- },
- "chartId": {
- "type": "integer",
- "description": "The ID of the chart to update.",
- "format": "int32"
}
},
- "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.)"
+ "id": "UpdateChartSpecRequest"
},
"DeleteFilterViewRequest": {
"properties": {
"filterId": {
- "type": "integer",
"description": "The ID of the filter to delete.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
},
"id": "DeleteFilterViewRequest",
@@ -1246,16 +3476,6 @@
"description": "The response when updating a range of values in a spreadsheet.",
"type": "object",
"properties": {
- "totalUpdatedSheets": {
- "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedCells": {
- "description": "The total number of cells updated.",
- "format": "int32",
- "type": "integer"
- },
"totalUpdatedColumns": {
"description": "The total number of columns where at least one cell in the column was\nupdated.",
"format": "int32",
@@ -1276,6 +3496,16 @@
"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"
}
},
"id": "BatchUpdateValuesResponse"
@@ -1303,7 +3533,6 @@
"type": "object",
"properties": {
"mergeType": {
- "type": "string",
"enumDescriptions": [
"Create a single merge from the range",
"Create a merge for each column in the range",
@@ -1314,7 +3543,8 @@
"MERGE_COLUMNS",
"MERGE_ROWS"
],
- "description": "How the cells should be merged."
+ "description": "How the cells should be merged.",
+ "type": "string"
},
"range": {
"description": "The range of cells to merge.",
@@ -1328,8 +3558,8 @@
"type": "object",
"properties": {
"protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)"
+ "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)",
+ "$ref": "ProtectedRange"
}
},
"id": "AddProtectedRangeRequest"
@@ -1360,48 +3590,27 @@
"id": "DuplicateFilterViewResponse"
},
"DuplicateSheetResponse": {
- "description": "The result of duplicating a sheet.",
- "type": "object",
"properties": {
"properties": {
"$ref": "SheetProperties",
"description": "The properties of the duplicate sheet."
}
},
- "id": "DuplicateSheetResponse"
- },
- "ClearBasicFilterRequest": {
- "type": "object",
- "properties": {
- "sheetId": {
- "description": "The sheet ID on which the basic filter should be cleared.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ClearBasicFilterRequest",
- "description": "Clears the basic filter, if any exists on the sheet."
+ "id": "DuplicateSheetResponse",
+ "description": "The result of duplicating a sheet.",
+ "type": "object"
},
"TextToColumnsRequest": {
- "type": "object",
"properties": {
"delimiter": {
"description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
"type": "string"
},
"source": {
- "description": "The source data range. This must span exactly one column.",
- "$ref": "GridRange"
+ "$ref": "GridRange",
+ "description": "The source data range. This must span exactly one column."
},
"delimiterType": {
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "\",\"",
- "\";\"",
- "\".\"",
- "\" \"",
- "A custom value as defined in delimiter."
- ],
"enum": [
"DELIMITER_TYPE_UNSPECIFIED",
"COMMA",
@@ -1411,23 +3620,32 @@
"CUSTOM"
],
"description": "The delimiter type to use.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "\",\"",
+ "\";\"",
+ "\".\"",
+ "\" \"",
+ "A custom value as defined in delimiter."
+ ]
}
},
"id": "TextToColumnsRequest",
- "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell."
+ "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
+ "type": "object"
},
- "DeleteBandingRequest": {
- "id": "DeleteBandingRequest",
- "description": "Removes the banded range with the given ID from the spreadsheet.",
- "type": "object",
+ "ClearBasicFilterRequest": {
"properties": {
- "bandedRangeId": {
- "description": "The ID of the banded range to delete.",
+ "sheetId": {
+ "description": "The sheet ID on which the basic filter should be cleared.",
"format": "int32",
"type": "integer"
}
- }
+ },
+ "id": "ClearBasicFilterRequest",
+ "description": "Clears the basic filter, if any exists on the sheet.",
+ "type": "object"
},
"BatchUpdateSpreadsheetResponse": {
"description": "The reply for batch updating a spreadsheet.",
@@ -1441,8 +3659,8 @@
}
},
"updatedSpreadsheet": {
- "$ref": "Spreadsheet",
- "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
+ "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`.",
+ "$ref": "Spreadsheet"
},
"spreadsheetId": {
"description": "The spreadsheet the updates were applied to.",
@@ -1451,7 +3669,21 @@
},
"id": "BatchUpdateSpreadsheetResponse"
},
+ "DeleteBandingRequest": {
+ "properties": {
+ "bandedRangeId": {
+ "description": "The ID of the banded range to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteBandingRequest",
+ "description": "Removes the banded range with the given ID from the spreadsheet.",
+ "type": "object"
+ },
"AppendValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
"properties": {
"updates": {
"$ref": "UpdateValuesResponse",
@@ -1466,24 +3698,25 @@
"type": "string"
}
},
- "id": "AppendValuesResponse",
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object"
+ "id": "AppendValuesResponse"
},
- "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"
},
"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.",
@@ -1493,29 +3726,28 @@
}
}
},
- "id": "PivotFilterCriteria"
+ "id": "PivotFilterCriteria",
+ "description": "Criteria for showing/hiding rows in a pivot table.",
+ "type": "object"
},
- "MoveDimensionRequest": {
- "description": "Moves one or more rows or columns.",
- "type": "object",
+ "AddFilterViewRequest": {
"properties": {
- "source": {
- "$ref": "DimensionRange",
- "description": "The source dimensions to move."
- },
- "destinationIndex": {
- "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
- "format": "int32",
- "type": "integer"
+ "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"
},
"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."
+ "description": "The rule to add.",
+ "$ref": "ConditionalFormatRule"
},
"index": {
"description": "The zero-based index where the rule should be inserted.",
@@ -1523,23 +3755,14 @@
"type": "integer"
}
},
- "id": "AddConditionalFormatRuleRequest",
- "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
- "type": "object"
+ "id": "AddConditionalFormatRuleRequest"
},
"ChartSpec": {
"description": "The specifications of a chart.",
"type": "object",
"properties": {
- "pieChart": {
- "description": "A pie chart specification.",
- "$ref": "PieChartSpec"
- },
- "basicChart": {
- "$ref": "BasicChartSpec",
- "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports."
- },
"hiddenDimensionStrategy": {
+ "description": "Determines how the charts will use hidden rows or columns.",
"type": "string",
"enumDescriptions": [
"Default value, do not use.",
@@ -1554,30 +3777,28 @@
"SKIP_HIDDEN_ROWS",
"SKIP_HIDDEN_COLUMNS",
"SHOW_ALL"
- ],
- "description": "Determines how the charts will use hidden rows or columns."
+ ]
},
"title": {
"description": "The title of the chart.",
"type": "string"
+ },
+ "pieChart": {
+ "description": "A pie chart specification.",
+ "$ref": "PieChartSpec"
+ },
+ "basicChart": {
+ "$ref": "BasicChartSpec",
+ "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports."
}
},
"id": "ChartSpec"
},
"NumberFormat": {
+ "description": "The number format of a cell.",
+ "type": "object",
"properties": {
"type": {
- "enum": [
- "NUMBER_FORMAT_TYPE_UNSPECIFIED",
- "TEXT",
- "NUMBER",
- "PERCENT",
- "CURRENCY",
- "DATE",
- "TIME",
- "DATE_TIME",
- "SCIENTIFIC"
- ],
"description": "The type of the number format.\nWhen writing, this field must be set.",
"type": "string",
"enumDescriptions": [
@@ -1590,16 +3811,25 @@
"Time formatting, e.g `3:59:00 PM`",
"Date+Time formatting, e.g `9/26/08 15:59:00`",
"Scientific number formatting, e.g `1.01E+03`"
+ ],
+ "enum": [
+ "NUMBER_FORMAT_TYPE_UNSPECIFIED",
+ "TEXT",
+ "NUMBER",
+ "PERCENT",
+ "CURRENCY",
+ "DATE",
+ "TIME",
+ "DATE_TIME",
+ "SCIENTIFIC"
]
},
"pattern": {
- "type": "string",
- "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."
+ "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",
- "description": "The number format of a cell.",
- "type": "object"
+ "id": "NumberFormat"
},
"SheetProperties": {
"description": "Properties of a sheet.",
@@ -1632,12 +3862,10 @@
"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"
+ "$ref": "GridProperties",
+ "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets."
},
"sheetType": {
- "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.",
@@ -1647,32 +3875,36 @@
"SHEET_TYPE_UNSPECIFIED",
"GRID",
"OBJECT"
- ]
+ ],
+ "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
+ "type": "string"
}
},
"id": "SheetProperties"
},
"UpdateDimensionPropertiesRequest": {
+ "description": "Updates properties of dimensions within the specified range.",
+ "type": "object",
"properties": {
"properties": {
"$ref": "DimensionProperties",
"description": "Properties to update."
},
"range": {
- "description": "The rows or columns to update.",
- "$ref": "DimensionRange"
+ "$ref": "DimensionRange",
+ "description": "The rows or columns to update."
},
"fields": {
- "type": "string",
"description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask"
+ "format": "google-fieldmask",
+ "type": "string"
}
},
- "id": "UpdateDimensionPropertiesRequest",
- "description": "Updates properties of dimensions within the specified range.",
- "type": "object"
+ "id": "UpdateDimensionPropertiesRequest"
},
"SourceAndDestination": {
+ "description": "A combination of a source range and how to extend that source.",
+ "type": "object",
"properties": {
"fillLength": {
"description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
@@ -1684,8 +3916,6 @@
"description": "The location of the data to use as the source of the autofill."
},
"dimension": {
- "description": "The dimension that data should be filled into.",
- "type": "string",
"enumDescriptions": [
"The default value, do not use.",
"Operates on the rows of a sheet.",
@@ -1695,81 +3925,92 @@
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
- ]
+ ],
+ "description": "The dimension that data should be filled into.",
+ "type": "string"
}
},
- "id": "SourceAndDestination",
- "description": "A combination of a source range and how to extend that source.",
- "type": "object"
+ "id": "SourceAndDestination"
},
"FilterView": {
+ "description": "A filter view.",
"type": "object",
"properties": {
- "sortSpecs": {
- "type": "array",
- "items": {
- "$ref": "SortSpec"
- },
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications."
- },
"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": {
- "type": "integer",
"description": "The ID of the filter view.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"criteria": {
- "type": "object",
"additionalProperties": {
"$ref": "FilterCriteria"
},
- "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column."
+ "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."
+ "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "$ref": "GridRange"
+ },
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "type": "array",
+ "items": {
+ "$ref": "SortSpec"
+ }
}
},
- "id": "FilterView",
- "description": "A filter view."
+ "id": "FilterView"
},
"BandingProperties": {
- "id": "BandingProperties",
"description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
"type": "object",
"properties": {
"secondBandColor": {
- "$ref": "Color",
- "description": "The second color that is alternating. (Required)"
+ "description": "The second color that is alternating. (Required)",
+ "$ref": "Color"
},
"footerColor": {
- "$ref": "Color",
- "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn."
+ "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": {
- "$ref": "Color",
- "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would."
+ "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would.",
+ "$ref": "Color"
},
"firstBandColor": {
"$ref": "Color",
"description": "The first color that is alternating. (Required)"
}
- }
+ },
+ "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",
"properties": {
"range": {
- "$ref": "GridRange",
- "description": "The range the filter covers."
+ "description": "The range the filter covers.",
+ "$ref": "GridRange"
},
"criteria": {
"additionalProperties": {
@@ -1779,28 +4020,31 @@
"type": "object"
},
"sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
"type": "array",
"items": {
"$ref": "SortSpec"
- },
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications."
+ }
}
},
"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": {
"properties": {
+ "updatedRows": {
+ "description": "The number of rows where at least one cell in the row was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "updatedData": {
+ "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`.",
+ "$ref": "ValueRange"
+ },
+ "updatedColumns": {
+ "description": "The number of columns where at least one cell in the column was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
"spreadsheetId": {
"description": "The spreadsheet the updates were applied to.",
"type": "string"
@@ -1813,20 +4057,6 @@
"description": "The number of cells updated.",
"format": "int32",
"type": "integer"
- },
- "updatedData": {
- "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`.",
- "$ref": "ValueRange"
- },
- "updatedRows": {
- "description": "The number of rows where at least one cell in the row was updated.",
- "format": "int32",
- "type": "integer"
- },
- "updatedColumns": {
- "description": "The number of columns where at least one cell in the column was updated.",
- "format": "int32",
- "type": "integer"
}
},
"id": "UpdateValuesResponse",
@@ -1837,15 +4067,6 @@
"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"
@@ -1887,14 +4108,25 @@
],
"description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported.",
"type": "string"
+ },
+ "sourceColumnOffset": {
+ "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "A name to use for the value. This is only used if formula was set.\nOtherwise, the column name is used.",
+ "type": "string"
}
},
"id": "PivotValue"
},
"ErrorValue": {
- "description": "An error in a cell.",
- "type": "object",
"properties": {
+ "message": {
+ "description": "A message with more information about the error\n(in the spreadsheet's locale).",
+ "type": "string"
+ },
"type": {
"description": "The type of error.",
"type": "string",
@@ -1922,26 +4154,25 @@
"N_A",
"LOADING"
]
- },
- "message": {
- "description": "A message with more information about the error\n(in the spreadsheet's locale).",
- "type": "string"
}
},
- "id": "ErrorValue"
+ "id": "ErrorValue",
+ "description": "An error in a cell.",
+ "type": "object"
},
"CopySheetToAnotherSpreadsheetRequest": {
+ "description": "The request to copy a sheet across spreadsheets.",
"type": "object",
"properties": {
"destinationSpreadsheetId": {
- "type": "string",
- "description": "The ID of the spreadsheet to copy the sheet to."
+ "description": "The ID of the spreadsheet to copy the sheet to.",
+ "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": {
"valuesIndex": {
@@ -1950,2254 +4181,21 @@
"type": "integer"
},
"buckets": {
+ "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
"type": "array",
"items": {
"$ref": "ExtendedValue"
- },
- "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."
- }
- },
- "id": "PivotGroupSortValueBucket",
- "description": "Information about which values in a pivot group should be used for sorting."
- },
- "EmbeddedObjectPosition": {
- "properties": {
- "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."
- },
- "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"
- }
- },
- "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": {
- "type": "object",
- "properties": {
- "useAlternateSeries": {
- "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
- "type": "boolean"
- },
- "sourceAndDestination": {
- "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data.",
- "$ref": "SourceAndDestination"
- },
- "range": {
- "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range.",
- "$ref": "GridRange"
- }
- },
- "id": "AutoFillRequest",
- "description": "Fills in more data based on existing data."
- },
- "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": {
- "$ref": "InterpolationPoint",
- "description": "The final interpolation point."
- }
- },
- "id": "GradientRule"
- },
- "SetBasicFilterRequest": {
- "description": "Sets the basic filter associated with a sheet.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "BasicFilter",
- "description": "The filter to set."
- }
- },
- "id": "SetBasicFilterRequest"
- },
- "ClearValuesRequest": {
- "description": "The request for clearing a range of values in a spreadsheet.",
- "type": "object",
- "properties": {},
- "id": "ClearValuesRequest"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "DuplicateFilterViewRequest": {
- "id": "DuplicateFilterViewRequest",
- "description": "Duplicates a particular filter view.",
- "type": "object",
- "properties": {
- "filterId": {
- "description": "The ID of the filter being duplicated.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "DeleteSheetRequest": {
- "description": "Deletes the requested sheet.",
- "type": "object",
- "properties": {
- "sheetId": {
- "description": "The ID of the sheet to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteSheetRequest"
- },
- "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": {
- "$ref": "ConditionalFormatRule",
- "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
- }
- }
- },
- "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"
- },
- "DuplicateSheetRequest": {
- "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": {
- "type": "integer",
- "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
- "format": "int32"
- },
- "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"
- }
- },
- "id": "DuplicateSheetRequest",
- "description": "Duplicates the contents of a sheet.",
- "type": "object"
- },
- "ExtendedValue": {
- "id": "ExtendedValue",
- "description": "The kinds of value that a cell in a spreadsheet can have.",
- "type": "object",
- "properties": {
- "stringValue": {
- "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
- "type": "string"
- },
- "boolValue": {
- "description": "Represents a boolean value.",
- "type": "boolean"
- },
- "formulaValue": {
- "description": "Represents a formula.",
- "type": "string"
- },
- "numberValue": {
- "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
- "format": "double",
- "type": "number"
- },
- "errorValue": {
- "description": "Represents an error.\nThis field is read-only.",
- "$ref": "ErrorValue"
- }
- }
- },
- "AddChartRequest": {
- "id": "AddChartRequest",
- "description": "Adds a chart to a sheet in the spreadsheet.",
- "type": "object",
- "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.)"
- }
- }
- },
- "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": {
- "description": "The response when clearing a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "clearedRanges": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)"
- }
- },
- "id": "BatchClearValuesResponse"
- },
- "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": {
- "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified.",
- "$ref": "BandingProperties"
- },
- "columnProperties": {
- "description": "Properties for column bands. These properties will be applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified.",
- "$ref": "BandingProperties"
- }
- },
- "id": "BandedRange"
- },
- "UpdateProtectedRangeRequest": {
- "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
- "type": "object",
- "properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to update with the new properties."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateProtectedRangeRequest"
- },
- "TextFormat": {
- "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
- "type": "object",
- "properties": {
- "underline": {
- "description": "True if the text is underlined.",
- "type": "boolean"
- },
- "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"
- },
- "AddSheetResponse": {
- "description": "The result of adding a sheet.",
- "type": "object",
- "properties": {
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the newly added sheet."
- }
- },
- "id": "AddSheetResponse"
- },
- "AddFilterViewResponse": {
- "properties": {
- "filter": {
- "description": "The newly added filter view.",
- "$ref": "FilterView"
- }
- },
- "id": "AddFilterViewResponse",
- "description": "The result of adding a filter view.",
- "type": "object"
- },
- "IterativeCalculationSettings": {
- "type": "object",
- "properties": {
- "convergenceThreshold": {
- "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.",
- "format": "double",
- "type": "number"
- },
- "maxIterations": {
- "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "IterativeCalculationSettings",
- "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation."
- },
- "SpreadsheetProperties": {
- "description": "Properties of a spreadsheet.",
- "type": "object",
- "properties": {
- "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."
- },
- "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."
- },
- "autoRecalc": {
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "Volatile functions are updated on every change.",
- "Volatile functions are updated on every change and every minute.",
- "Volatile functions are updated on every change and hourly."
- ],
- "enum": [
- "RECALCULATION_INTERVAL_UNSPECIFIED",
- "ON_CHANGE",
- "MINUTE",
- "HOUR"
- ],
- "description": "The amount of time to wait before volatile functions are recalculated.",
- "type": "string"
- }
- },
- "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": {
- "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": {
- "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"
- },
- "AddChartResponse": {
- "description": "The result of adding a chart to a spreadsheet.",
- "type": "object",
- "properties": {
- "chart": {
- "description": "The newly added chart.",
- "$ref": "EmbeddedChart"
- }
- },
- "id": "AddChartResponse"
- },
- "InsertDimensionRequest": {
- "id": "InsertDimensionRequest",
- "description": "Inserts rows or columns in a sheet at a particular index.",
- "type": "object",
- "properties": {
- "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"
- }
- }
- },
- "UpdateSpreadsheetPropertiesRequest": {
- "properties": {
- "fields": {
- "type": "string",
- "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask"
- },
- "properties": {
- "$ref": "SpreadsheetProperties",
- "description": "The properties to update."
- }
- },
- "id": "UpdateSpreadsheetPropertiesRequest",
- "description": "Updates properties of a spreadsheet.",
- "type": "object"
- },
- "BatchUpdateValuesRequest": {
- "id": "BatchUpdateValuesRequest",
- "description": "The request for updating more than one range of values in a spreadsheet.",
- "type": "object",
- "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": {
- "enumDescriptions": [
- "Default input value. This value must not be used.",
- "The values the user has entered will not be parsed and will be stored\nas-is.",
- "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
- ],
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "type": "string"
- },
- "data": {
- "description": "The new values to apply to the spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "ValueRange"
- }
- },
- "responseDateTimeRenderOption": {
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string",
- "enumDescriptions": [
- "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
- "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
- ],
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ]
- }
- }
- },
- "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"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range that is being protected.\nThe range may be fully unbounded, in which case this is considered\na protected sheet.\n\nWhen writing, only one of range or named_range_id\nmay be set."
- },
- "editors": {
- "$ref": "Editors",
- "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection."
- },
- "description": {
- "description": "The description of this protected range.",
- "type": "string"
- },
- "unprotectedRanges": {
- "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- },
- "namedRangeId": {
- "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "type": "string"
- },
- "protectedRangeId": {
- "type": "integer",
- "description": "The ID of the protected range.\nThis field is read-only.",
- "format": "int32"
- },
- "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"
- },
- "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"
- },
- "DimensionRange": {
- "id": "DimensionRange",
- "description": "A range along a single dimension on a sheet.\nAll indexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side.",
- "type": "object",
- "properties": {
- "dimension": {
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "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."
- ]
- },
- "startIndex": {
- "description": "The start (inclusive) of the span, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "endIndex": {
- "description": "The end (exclusive) of the span, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet this span is on.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "NamedRange": {
- "id": "NamedRange",
- "description": "A named range.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range this represents."
- },
- "name": {
- "description": "The name of the named range.",
- "type": "string"
- },
- "namedRangeId": {
- "type": "string",
- "description": "The ID of the named range."
- }
- }
- },
- "CutPasteRequest": {
- "description": "Moves data from the source to the destination.",
- "type": "object",
- "properties": {
- "source": {
- "description": "The source data to cut.",
- "$ref": "GridRange"
- },
- "pasteType": {
- "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
- "type": "string",
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
- "enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ]
- },
- "destination": {
- "$ref": "GridCoordinate",
- "description": "The top-left coordinate where the data should be pasted."
- }
- },
- "id": "CutPasteRequest"
- },
- "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."
- },
- "left": {
- "$ref": "Border",
- "description": "The left border of the cell."
- }
- },
- "id": "Borders"
- },
- "BasicChartSeries": {
- "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
- "type": "object",
- "properties": {
- "series": {
- "description": "The data being visualized in this chart series.",
- "$ref": "ChartData"
- },
- "type": {
- "enumDescriptions": [
- "Default value, do not use.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.",
- "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e."
- ],
- "enum": [
- "BASIC_CHART_TYPE_UNSPECIFIED",
- "BAR",
- "LINE",
- "AREA",
- "COLUMN",
- "SCATTER",
- "COMBO"
- ],
- "description": "The type of this series. Valid only if the\nchartType is\nCOMBO.\nDifferent types will change the way the series is visualized.\nOnly LINE, AREA,\nand COLUMN are supported.",
- "type": "string"
- },
- "targetAxis": {
- "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
- "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
- "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
- ],
- "enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
- ]
- }
- },
- "id": "BasicChartSeries"
- },
- "AutoResizeDimensionsRequest": {
- "type": "object",
- "properties": {
- "dimensions": {
- "$ref": "DimensionRange",
- "description": "The dimensions to automatically resize.\nOnly COLUMNS are supported."
- }
- },
- "id": "AutoResizeDimensionsRequest",
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
- },
- "UpdateBordersRequest": {
- "id": "UpdateBordersRequest",
- "description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.",
- "type": "object",
- "properties": {
- "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": {
- "$ref": "GridRange",
- "description": "The range whose borders should be updated."
- },
- "innerHorizontal": {
- "$ref": "Border",
- "description": "The horizontal border to put within the range."
- },
- "top": {
- "$ref": "Border",
- "description": "The border to put at the top of the range."
- },
- "left": {
- "$ref": "Border",
- "description": "The border to put at the left of the range."
- },
- "bottom": {
- "$ref": "Border",
- "description": "The border to put at the bottom of the range."
- }
- }
- },
- "CellFormat": {
- "type": "object",
- "properties": {
- "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.",
- "The text is explicitly aligned to the left of the cell.",
- "The text is explicitly aligned to the center of the cell.",
- "The text is explicitly aligned to the right of the cell."
- ],
- "enum": [
- "HORIZONTAL_ALIGN_UNSPECIFIED",
- "LEFT",
- "CENTER",
- "RIGHT"
- ],
- "description": "The horizontal alignment of the value in the cell.",
- "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.",
- "A hyperlink should not be rendered."
- ],
- "enum": [
- "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
- "LINKED",
- "PLAIN_TEXT"
- ]
- },
- "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": {
- "description": "The padding of the cell.",
- "$ref": "Padding"
- },
- "verticalAlignment": {
- "enum": [
- "VERTICAL_ALIGN_UNSPECIFIED",
- "TOP",
- "MIDDLE",
- "BOTTOM"
- ],
- "description": "The vertical alignment of the value in the cell.",
- "type": "string",
- "enumDescriptions": [
- "The vertical alignment is not specified. Do not use this.",
- "The text is explicitly aligned to the top of the cell.",
- "The text is explicitly aligned to the middle of the cell.",
- "The text is explicitly aligned to the bottom of the cell."
- ]
- },
- "textDirection": {
- "description": "The direction of the text in the cell.",
- "type": "string",
- "enumDescriptions": [
- "The text direction is not specified. Do not use this.",
- "The text direction of left-to-right was set by the user.",
- "The text direction of right-to-left was set by the user."
- ],
- "enum": [
- "TEXT_DIRECTION_UNSPECIFIED",
- "LEFT_TO_RIGHT",
- "RIGHT_TO_LEFT"
- ]
- },
- "borders": {
- "$ref": "Borders",
- "description": "The borders of the cell."
- },
- "textRotation": {
- "description": "The rotation applied to text in a cell",
- "$ref": "TextRotation"
- },
- "wrapStrategy": {
- "enum": [
- "WRAP_STRATEGY_UNSPECIFIED",
- "OVERFLOW_CELL",
- "LEGACY_WRAP",
- "CLIP",
- "WRAP"
- ],
- "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. |"
- ]
- }
- },
- "id": "CellFormat",
- "description": "The format of a cell."
- },
- "ClearValuesResponse": {
- "description": "The response when clearing a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "clearedRange": {
- "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
- "type": "string"
- }
- },
- "id": "ClearValuesResponse"
- },
- "DeleteConditionalFormatRuleRequest": {
- "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
- "type": "object",
- "properties": {
- "index": {
- "description": "The zero-based index of the rule to be deleted.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet the rule is being deleted from.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteConditionalFormatRuleRequest"
- },
- "AddBandingResponse": {
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range that was added."
- }
- },
- "id": "AddBandingResponse",
- "description": "The result of adding a banded range.",
- "type": "object"
- },
- "DeleteNamedRangeRequest": {
- "description": "Removes the named range with the given ID from the spreadsheet.",
- "type": "object",
- "properties": {
- "namedRangeId": {
- "description": "The ID of the named range to delete.",
- "type": "string"
- }
- },
- "id": "DeleteNamedRangeRequest"
- },
- "ChartData": {
- "description": "The data included in a domain or series.",
- "type": "object",
- "properties": {
- "sourceRange": {
- "$ref": "ChartSourceRange",
- "description": "The source ranges of the data."
- }
- },
- "id": "ChartData"
- },
- "BatchGetValuesResponse": {
- "description": "The response when retrieving more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "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"
}
}
},
- "id": "BatchGetValuesResponse"
- },
- "UpdateBandingRequest": {
- "description": "Updates properties of the supplied banded range.",
- "type": "object",
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range to update with the new properties."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `bandedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateBandingRequest"
- },
- "Color": {
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
- "type": "object",
- "properties": {
- "red": {
- "type": "number",
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "format": "float"
- },
- "green": {
- "description": "The amount of green in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "blue": {
- "description": "The amount of blue in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "alpha": {
- "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
- "format": "float",
- "type": "number"
- }
- },
- "id": "Color"
- },
- "PivotGroup": {
- "description": "A single grouping (either row or column) in a pivot table.",
- "type": "object",
- "properties": {
- "sortOrder": {
- "type": "string",
- "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."
- },
- "valueBucket": {
- "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values.",
- "$ref": "PivotGroupSortValueBucket"
- },
- "sourceColumnOffset": {
- "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
- "format": "int32",
- "type": "integer"
- },
- "showTotals": {
- "description": "True if the pivot table should include the totals for this grouping.",
- "type": "boolean"
- },
- "valueMetadata": {
- "description": "Metadata about values in the grouping.",
- "type": "array",
- "items": {
- "$ref": "PivotGroupValueMetadata"
- }
- }
- },
- "id": "PivotGroup"
- },
- "PivotTable": {
- "description": "A pivot table.",
- "type": "object",
- "properties": {
- "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"
- },
- "columns": {
- "description": "Each column grouping in the pivot table.",
- "type": "array",
- "items": {
- "$ref": "PivotGroup"
- }
- },
- "values": {
- "type": "array",
- "items": {
- "$ref": "PivotValue"
- },
- "description": "A list of values to include in the pivot table."
- },
- "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": {
- "type": "array",
- "items": {
- "$ref": "PivotGroup"
- },
- "description": "Each row grouping in the pivot table."
- }
- },
- "id": "PivotTable"
- },
- "ChartSourceRange": {
- "description": "Source ranges for a chart.",
- "type": "object",
- "properties": {
- "sources": {
- "type": "array",
- "items": {
- "$ref": "GridRange"
- },
- "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"
- }
- },
- "id": "ChartSourceRange"
- },
- "AppendCellsRequest": {
- "properties": {
- "rows": {
- "description": "The data to append.",
- "type": "array",
- "items": {
- "$ref": "RowData"
- }
- },
- "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"
- },
- "sheetId": {
- "type": "integer",
- "description": "The sheet ID to append the data to.",
- "format": "int32"
- }
- },
- "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": {
- "majorDimension": {
- "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",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
- },
- "values": {
- "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "range": {
- "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
- "type": "string"
- }
- },
- "id": "ValueRange"
- },
- "AddBandingRequest": {
- "id": "AddBandingRequest",
- "description": "Adds a new banded range to the spreadsheet.",
- "type": "object",
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
- }
- }
- },
- "Response": {
- "description": "A single response from an update.",
- "type": "object",
- "properties": {
- "addNamedRange": {
- "$ref": "AddNamedRangeResponse",
- "description": "A reply from adding a named range."
- },
- "addFilterView": {
- "$ref": "AddFilterViewResponse",
- "description": "A reply from adding a filter view."
- },
- "addBanding": {
- "$ref": "AddBandingResponse",
- "description": "A reply from adding a banded range."
- },
- "addProtectedRange": {
- "description": "A reply from adding a protected range.",
- "$ref": "AddProtectedRangeResponse"
- },
- "duplicateSheet": {
- "$ref": "DuplicateSheetResponse",
- "description": "A reply from duplicating a sheet."
- },
- "updateEmbeddedObjectPosition": {
- "$ref": "UpdateEmbeddedObjectPositionResponse",
- "description": "A reply from updating an embedded object's position."
- },
- "deleteConditionalFormatRule": {
- "$ref": "DeleteConditionalFormatRuleResponse",
- "description": "A reply from deleting a conditional format rule."
- },
- "duplicateFilterView": {
- "$ref": "DuplicateFilterViewResponse",
- "description": "A reply from duplicating a filter view."
- },
- "addChart": {
- "$ref": "AddChartResponse",
- "description": "A reply from adding a chart."
- },
- "findReplace": {
- "$ref": "FindReplaceResponse",
- "description": "A reply from doing a find/replace."
- },
- "addSheet": {
- "$ref": "AddSheetResponse",
- "description": "A reply from adding a sheet."
- },
- "updateConditionalFormatRule": {
- "description": "A reply from updating a conditional format rule.",
- "$ref": "UpdateConditionalFormatRuleResponse"
- }
- },
- "id": "Response"
- },
- "EmbeddedChart": {
- "properties": {
- "chartId": {
- "description": "The ID of the chart.",
- "format": "int32",
- "type": "integer"
- },
- "position": {
- "$ref": "EmbeddedObjectPosition",
- "description": "The position of the chart."
- },
- "spec": {
- "$ref": "ChartSpec",
- "description": "The specification of the chart."
- }
- },
- "id": "EmbeddedChart",
- "description": "A chart embedded in a sheet.",
- "type": "object"
- },
- "TextFormatRun": {
- "type": "object",
- "properties": {
- "format": {
- "description": "The format of this run. Absent values inherit the cell's format.",
- "$ref": "TextFormat"
- },
- "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."
- },
- "InsertRangeRequest": {
- "id": "InsertRangeRequest",
- "description": "Inserts cells into a range, shifting the existing cells over or down.",
- "type": "object",
- "properties": {
- "shiftDimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
- "type": "string"
- },
- "range": {
- "description": "The range to insert new cells into.",
- "$ref": "GridRange"
- }
- }
- },
- "AddNamedRangeResponse": {
- "description": "The result of adding a named range.",
- "type": "object",
- "properties": {
- "namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to add."
- }
- },
- "id": "AddNamedRangeResponse"
- },
- "RowData": {
- "description": "Data about each cell in a row.",
- "type": "object",
- "properties": {
- "values": {
- "description": "The values in the row, one per column.",
- "type": "array",
- "items": {
- "$ref": "CellData"
- }
- }
- },
- "id": "RowData"
- },
- "Border": {
- "id": "Border",
- "description": "A border along a cell.",
- "type": "object",
- "properties": {
- "color": {
- "description": "The color of the border.",
- "$ref": "Color"
- },
- "width": {
- "type": "integer",
- "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
- "format": "int32"
- },
- "style": {
- "enumDescriptions": [
- "The style is not specified. Do not use this.",
- "The border is dotted.",
- "The border is dashed.",
- "The border is a thin solid line.",
- "The border is a medium solid line.",
- "The border is a thick solid line.",
- "No border.\nUsed only when updating a border in order to erase it.",
- "The border is two solid lines."
- ],
- "enum": [
- "STYLE_UNSPECIFIED",
- "DOTTED",
- "DASHED",
- "SOLID",
- "SOLID_MEDIUM",
- "SOLID_THICK",
- "NONE",
- "DOUBLE"
- ],
- "description": "The style of the border.",
- "type": "string"
- }
- }
- },
- "GridData": {
- "description": "Data in the grid, as well as metadata about the dimensions.",
- "type": "object",
- "properties": {
- "rowMetadata": {
- "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
- "type": "array",
- "items": {
- "$ref": "DimensionProperties"
- }
- },
- "rowData": {
- "type": "array",
- "items": {
- "$ref": "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."
- },
- "startRow": {
- "description": "The first row this GridData refers to, zero-based.",
- "format": "int32",
- "type": "integer"
- },
- "columnMetadata": {
- "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
- "type": "array",
- "items": {
- "$ref": "DimensionProperties"
- }
- },
- "startColumn": {
- "description": "The first column this GridData refers to, zero-based.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridData"
- },
- "FindReplaceRequest": {
- "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
- "type": "object",
- "properties": {
- "sheetId": {
- "description": "The sheet to find/replace over.",
- "format": "int32",
- "type": "integer"
- },
- "allSheets": {
- "type": "boolean",
- "description": "True to find/replace over all sheets."
- },
- "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"
- },
- "UpdateNamedRangeRequest": {
- "description": "Updates properties of the named range with the specified\nnamedRangeId.",
- "type": "object",
- "properties": {
- "namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to update with the new properties."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateNamedRangeRequest"
- },
- "AddSheetRequest": {
- "description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmbeddedObjectPosition.newSheet.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)",
- "$ref": "SheetProperties"
- }
- },
- "id": "AddSheetRequest"
- },
- "UpdateCellsRequest": {
- "description": "Updates all cells in a range with new data.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
- },
- "rows": {
- "description": "The data to write.",
- "type": "array",
- "items": {
- "$ref": "RowData"
- }
- },
- "fields": {
- "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "start": {
- "$ref": "GridCoordinate",
- "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written."
- }
- },
- "id": "UpdateCellsRequest"
- },
- "DeleteConditionalFormatRuleResponse": {
- "id": "DeleteConditionalFormatRuleResponse",
- "description": "The result of deleting a conditional format rule.",
- "type": "object",
- "properties": {
- "rule": {
- "$ref": "ConditionalFormatRule",
- "description": "The rule that was deleted."
- }
- }
- },
- "DeleteRangeRequest": {
- "type": "object",
- "properties": {
- "shiftDimension": {
- "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
- },
- "range": {
- "description": "The range of cells to delete.",
- "$ref": "GridRange"
- }
- },
- "id": "DeleteRangeRequest",
- "description": "Deletes a range of cells, shifting other cells into the deleted area."
- },
- "GridCoordinate": {
- "description": "A coordinate in a sheet.\nAll indexes are zero-based.",
- "type": "object",
- "properties": {
- "rowIndex": {
- "description": "The row index of the coordinate.",
- "format": "int32",
- "type": "integer"
- },
- "columnIndex": {
- "type": "integer",
- "description": "The column index of the coordinate.",
- "format": "int32"
- },
- "sheetId": {
- "description": "The sheet this coordinate is on.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridCoordinate"
- },
- "UpdateSheetPropertiesRequest": {
- "properties": {
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties to update."
- },
- "fields": {
- "type": "string",
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask"
- }
- },
- "id": "UpdateSheetPropertiesRequest",
- "description": "Updates properties of the sheet with the specified\nsheetId.",
- "type": "object"
- },
- "UnmergeCellsRequest": {
- "description": "Unmerges cells in the given range.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge."
- }
- },
- "id": "UnmergeCellsRequest"
- },
- "GridProperties": {
- "description": "Properties of a grid.",
- "type": "object",
- "properties": {
- "frozenRowCount": {
- "type": "integer",
- "description": "The number of rows that are frozen in the grid.",
- "format": "int32"
- },
- "hideGridlines": {
- "description": "True if the grid isn't showing gridlines in the UI.",
- "type": "boolean"
- },
- "columnCount": {
- "type": "integer",
- "description": "The number of columns in the grid.",
- "format": "int32"
- },
- "frozenColumnCount": {
- "description": "The number of columns that are frozen in the grid.",
- "format": "int32",
- "type": "integer"
- },
- "rowCount": {
- "description": "The number of rows in the grid.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridProperties"
- },
- "Sheet": {
- "properties": {
- "bandedRanges": {
- "type": "array",
- "items": {
- "$ref": "BandedRange"
- },
- "description": "The banded (i.e. alternating colors) ranges on this sheet."
- },
- "charts": {
- "description": "The specifications of every chart on this sheet.",
- "type": "array",
- "items": {
- "$ref": "EmbeddedChart"
- }
- },
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the sheet."
- },
- "filterViews": {
- "description": "The filter views in this sheet.",
- "type": "array",
- "items": {
- "$ref": "FilterView"
- }
- },
- "protectedRanges": {
- "description": "The protected ranges in this sheet.",
- "type": "array",
- "items": {
- "$ref": "ProtectedRange"
- }
- },
- "conditionalFormats": {
- "type": "array",
- "items": {
- "$ref": "ConditionalFormatRule"
- },
- "description": "The conditional format rules in this sheet."
- },
- "basicFilter": {
- "description": "The filter on this sheet, if any.",
- "$ref": "BasicFilter"
- },
- "merges": {
- "description": "The ranges that are merged together.",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- },
- "data": {
- "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
- "type": "array",
- "items": {
- "$ref": "GridData"
- }
- }
- },
- "id": "Sheet",
- "description": "A sheet in a spreadsheet.",
- "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": {
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The order data should be sorted.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ]
- }
- },
- "id": "SortSpec"
- },
- "UpdateEmbeddedObjectPositionResponse": {
- "description": "The result of updating an embedded object's position.",
- "type": "object",
- "properties": {
- "position": {
- "$ref": "EmbeddedObjectPosition",
- "description": "The new position of the embedded object."
- }
- },
- "id": "UpdateEmbeddedObjectPositionResponse"
- },
- "BooleanRule": {
- "type": "object",
- "properties": {
- "format": {
- "$ref": "CellFormat",
- "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color."
- },
- "condition": {
- "$ref": "BooleanCondition",
- "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
- }
- },
- "id": "BooleanRule",
- "description": "A rule that may or may not match, depending on the condition."
- },
- "FilterCriteria": {
- "description": "Criteria for showing/hiding rows in a filter or filter view.",
- "type": "object",
- "properties": {
- "hiddenValues": {
- "description": "Values that should be hidden.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "condition": {
- "$ref": "BooleanCondition",
- "description": "A condition that must be true for values to be shown.\n(This does not override hiddenValues -- if a value is listed there,\n it will still be hidden.)"
- }
- },
- "id": "FilterCriteria"
- },
- "PivotGroupValueMetadata": {
- "type": "object",
- "properties": {
- "value": {
- "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)",
- "$ref": "ExtendedValue"
- },
- "collapsed": {
- "description": "True if the data corresponding to the value is collapsed.",
- "type": "boolean"
- }
- },
- "id": "PivotGroupValueMetadata",
- "description": "Metadata about a value in a pivot grouping."
- },
- "Editors": {
- "properties": {
- "users": {
- "description": "The email addresses of users with edit access to the protected range.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "groups": {
- "description": "The email addresses of groups with edit access to the protected range.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "domainUsersCanEdit": {
- "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.",
- "type": "boolean"
- }
- },
- "id": "Editors",
- "description": "The editors of a protected range.",
- "type": "object"
- },
- "UpdateConditionalFormatRuleRequest": {
- "properties": {
- "sheetId": {
- "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
- "format": "int32",
- "type": "integer"
- },
- "newIndex": {
- "description": "The zero-based new index the rule should end up at.",
- "format": "int32",
- "type": "integer"
- },
- "rule": {
- "description": "The rule that should replace the rule at the given index.",
- "$ref": "ConditionalFormatRule"
- },
- "index": {
- "description": "The zero-based index of the rule that should be replaced or moved.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "UpdateConditionalFormatRuleRequest",
- "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
- "type": "object"
- },
- "DataValidationRule": {
- "description": "A data validation rule.",
- "type": "object",
- "properties": {
- "condition": {
- "$ref": "BooleanCondition",
- "description": "The condition that data in the cell must match."
- },
- "showCustomUi": {
- "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
- "type": "boolean"
- },
- "strict": {
- "description": "True if invalid data should be rejected.",
- "type": "boolean"
- },
- "inputMessage": {
- "type": "string",
- "description": "A message to show the user when adding data to the cell."
- }
- },
- "id": "DataValidationRule"
- },
- "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": {
- "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
- "type": "object",
- "properties": {
- "html": {
- "description": "True if the data is HTML.",
- "type": "boolean"
- },
- "coordinate": {
- "$ref": "GridCoordinate",
- "description": "The coordinate at which the data should start being inserted."
- },
- "data": {
- "description": "The data to insert.",
- "type": "string"
- },
- "delimiter": {
- "description": "The delimiter in the data.",
- "type": "string"
- },
- "type": {
- "description": "How the data should be pasted.",
- "type": "string",
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
- "enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ]
- }
- },
- "id": "PasteDataRequest"
- },
- "AppendDimensionRequest": {
- "description": "Appends rows or columns to the end of a sheet.",
- "type": "object",
- "properties": {
- "sheetId": {
- "type": "integer",
- "description": "The sheet to append rows or columns to.",
- "format": "int32"
- },
- "dimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "Whether rows or columns should be appended.",
- "type": "string"
- },
- "length": {
- "description": "The number of rows or columns to append.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AppendDimensionRequest"
- },
- "AddNamedRangeRequest": {
- "description": "Adds a named range to the spreadsheet.",
- "type": "object",
- "properties": {
- "namedRange": {
- "description": "The named range to add. The namedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)",
- "$ref": "NamedRange"
- }
- },
- "id": "AddNamedRangeRequest"
- },
- "UpdateEmbeddedObjectPositionRequest": {
- "type": "object",
- "properties": {
- "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"
- }
- },
- "id": "UpdateEmbeddedObjectPositionRequest",
- "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image)."
- },
- "TextRotation": {
- "type": "object",
- "properties": {
- "vertical": {
- "description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
- "type": "boolean"
- },
- "angle": {
- "description": "The angle between the standard orientation and the desired orientation.\nMeasured in degrees. Valid values are between -90 and 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNote: For LTR text direction positive angles are in the counterclockwise\ndirection, whereas for RTL they are in the clockwise direction",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TextRotation",
- "description": "The rotation applied to text in a cell."
- },
- "PieChartSpec": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
- "type": "object",
- "properties": {
- "domain": {
- "$ref": "ChartData",
- "description": "The data that covers the domain of the pie chart."
- },
- "threeDimensional": {
- "description": "True if the pie is three dimensional.",
- "type": "boolean"
- },
- "series": {
- "description": "The data that covers the one and only series of the pie chart.",
- "$ref": "ChartData"
- },
- "legendPosition": {
- "description": "Where the legend of the pie chart should be drawn.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered.",
- "Each pie slice has a label attached to it."
- ],
- "enum": [
- "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND",
- "LABELED_LEGEND"
- ]
- },
- "pieHole": {
- "description": "The size of the hole in the pie chart.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "PieChartSpec"
- },
- "UpdateFilterViewRequest": {
- "properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The new properties of the filter view."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `filter` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateFilterViewRequest",
- "description": "Updates properties of the filter view.",
- "type": "object"
- },
- "ConditionalFormatRule": {
- "type": "object",
- "properties": {
- "booleanRule": {
- "$ref": "BooleanRule",
- "description": "The formatting is either \"on\" or \"off\" according to the rule."
- },
- "ranges": {
- "description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- },
- "gradientRule": {
- "$ref": "GradientRule",
- "description": "The formatting will vary based on the gradients in the rule."
- }
- },
- "id": "ConditionalFormatRule",
- "description": "A rule describing a conditional format."
+ "id": "PivotGroupSortValueBucket"
}
},
- "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Sheets",
"auth": {
"oauth2": {
@@ -4223,5 +4221,7 @@
"rootUrl": "https://sheets.googleapis.com/",
"ownerDomain": "google.com",
"name": "sheets",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "title": "Google Sheets API",
+ "ownerName": "Google"
}
diff --git a/sheets/v4/sheets-gen.go b/sheets/v4/sheets-gen.go
index 608a9e2..bb1b59a 100644
--- a/sheets/v4/sheets-gen.go
+++ b/sheets/v4/sheets-gen.go
@@ -1340,8 +1340,9 @@
// rendered. This is ignored if response_value_render_option
// is
// FORMATTED_VALUE.
- // The default dateTime render option is
- // [DateTimeRenderOption.SERIAL_NUMBER].
+ // The default dateTime render option
+ // is
+ // DateTimeRenderOption.SERIAL_NUMBER.
//
// Possible values:
// "SERIAL_NUMBER" - Instructs date, time, datetime, and duration
diff --git a/slides/v1/slides-api.json b/slides/v1/slides-api.json
index 0f58719..55a0862 100644
--- a/slides/v1/slides-api.json
+++ b/slides/v1/slides-api.json
@@ -1,286 +1,617 @@
{
- "resources": {
- "presentations": {
- "methods": {
- "get": {
- "flatPath": "v1/presentations/{presentationsId}",
- "path": "v1/presentations/{+presentationId}",
- "id": "slides.presentations.get",
- "description": "Gets the latest version of the specified presentation.",
- "response": {
- "$ref": "Presentation"
- },
- "parameterOrder": [
- "presentationId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "presentationId": {
- "pattern": "^[^/]+$",
- "location": "path",
- "description": "The ID of the presentation to retrieve.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/presentations.readonly"
- ]
- },
- "create": {
- "response": {
- "$ref": "Presentation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/presentations"
- ],
- "flatPath": "v1/presentations",
- "path": "v1/presentations",
- "id": "slides.presentations.create",
- "request": {
- "$ref": "Presentation"
- },
- "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation."
- },
- "batchUpdate": {
- "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"
- },
- "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"
- }
- }
- }
- },
- "resources": {
- "pages": {
- "methods": {
- "getThumbnail": {
- "httpMethod": "GET",
- "parameterOrder": [
- "presentationId",
- "pageObjectId"
- ],
- "response": {
- "$ref": "Thumbnail"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/presentations.readonly"
- ],
- "parameters": {
- "thumbnailProperties.mimeType": {
- "location": "query",
- "enum": [
- "PNG"
- ],
- "description": "The optional mime type of the thumbnail image.\n\nIf you don't specify the mime type, the default mime type will be PNG.",
- "type": "string"
- },
- "thumbnailProperties.thumbnailSize": {
- "location": "query",
- "enum": [
- "THUMBNAIL_SIZE_UNSPECIFIED",
- "LARGE"
- ],
- "description": "The optional thumbnail image size.\n\nIf you don't specify the size, the server chooses a default size of the\nimage.",
- "type": "string"
- },
- "presentationId": {
- "description": "The ID of the presentation to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageObjectId": {
- "description": "The object ID of the page whose thumbnail to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
- "id": "slides.presentations.pages.getThumbnail",
- "path": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
- "description": "Generates a thumbnail of the latest version of the specified page in the\npresentation and returns a URL to the thumbnail image."
- },
- "get": {
- "description": "Gets the latest version of the specified page in the presentation.",
- "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": {
- "pageObjectId": {
- "location": "path",
- "description": "The object ID of the page to retrieve.",
- "required": true,
- "type": "string"
- },
- "presentationId": {
- "location": "path",
- "description": "The ID of the presentation to retrieve.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "path": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "id": "slides.presentations.pages.get"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "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": {
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://slides.googleapis.com/",
+ "description": "An API for creating and editing Google Slides presentations.",
"kind": "discovery#restDescription",
"servicePath": "",
- "description": "An API for creating and editing Google Slides presentations.",
"basePath": "",
+ "revision": "20170530",
"id": "slides:v1",
"documentationLink": "https://developers.google.com/slides/",
- "revision": "20170503",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "PageElement": {
+ "properties": {
+ "size": {
+ "$ref": "Size",
+ "description": "The size of the page element."
+ },
+ "sheetsChart": {
+ "$ref": "SheetsChart",
+ "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images."
+ },
+ "title": {
+ "type": "string",
+ "description": "The title of the page element. Combined with description to display alt\ntext."
+ },
+ "video": {
+ "$ref": "Video",
+ "description": "A video page element."
+ },
+ "wordArt": {
+ "description": "A word art page element.",
+ "$ref": "WordArt"
+ },
+ "table": {
+ "description": "A table page element.",
+ "$ref": "Table"
+ },
+ "objectId": {
+ "description": "The object ID for this page element. Object IDs used by\ngoogle.apps.slides.v1.Page and\ngoogle.apps.slides.v1.PageElement share the same namespace.",
+ "type": "string"
+ },
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "The transform of the page element."
+ },
+ "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."
+ }
+ },
+ "id": "PageElement",
+ "description": "A visual element rendered on a page.",
+ "type": "object"
+ },
+ "CreateImageRequest": {
+ "id": "CreateImageRequest",
+ "description": "Creates an image.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "CreateParagraphBulletsRequest": {
+ "description": "Creates bullets for all of the paragraphs that overlap with the given\ntext index range.\n\nThe nesting level of each paragraph will be determined by counting leading\ntabs in front of each paragraph. To avoid excess space between the bullet and\nthe corresponding paragraph, these leading tabs are removed by this request.\nThis may change the indices of parts of the text.\n\nIf the paragraph immediately before paragraphs being updated is in a list\nwith a matching preset, the paragraphs being updated are added to that\npreceding list.",
+ "type": "object",
+ "properties": {
+ "bulletPreset": {
+ "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."
+ ]
+ },
+ "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": {
+ "type": "string",
+ "description": "The object ID of the shape or table containing the text to add bullets to."
+ },
+ "textRange": {
+ "description": "The range of text to apply the bullet presets to, based on TextElement indexes.",
+ "$ref": "Range"
+ }
+ },
+ "id": "CreateParagraphBulletsRequest"
+ },
+ "Size": {
+ "type": "object",
+ "properties": {
+ "height": {
+ "description": "The height of the object.",
+ "$ref": "Dimension"
+ },
+ "width": {
+ "$ref": "Dimension",
+ "description": "The width of the object."
+ }
+ },
+ "id": "Size",
+ "description": "A width and height."
+ },
+ "TextStyle": {
+ "properties": {
+ "fontFamily": {
+ "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.\n\nSome fonts can affect the weight of the text. If an update request\nspecifies values for both `font_family` and `bold`, the explicitly-set\n`bold` value is used.",
+ "type": "string"
+ },
+ "italic": {
+ "description": "Whether or not the text is italicized.",
+ "type": "boolean"
+ },
+ "strikethrough": {
+ "description": "Whether or not the text is struck through.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "$ref": "Dimension",
+ "description": "The size of the text's font. When read, the `font_size` will specified in\npoints."
+ },
+ "baselineOffset": {
+ "type": "string",
+ "enumDescriptions": [
+ "The text's baseline offset is inherited from the parent.",
+ "The text is not vertically offset.",
+ "The text is vertically offset upwards (superscript).",
+ "The text is vertically offset downwards (subscript)."
+ ],
+ "enum": [
+ "BASELINE_OFFSET_UNSPECIFIED",
+ "NONE",
+ "SUPERSCRIPT",
+ "SUBSCRIPT"
+ ],
+ "description": "The text's vertical offset from its normal position.\n\nText with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically\nrendered in a smaller font size, computed based on the `font_size` field.\nThe `font_size` itself is not affected by changes in this field."
+ },
+ "weightedFontFamily": {
+ "$ref": "WeightedFontFamily",
+ "description": "The font family and rendered weight of the text.\n\nThis field is an extension of `font_family` meant to support explicit font\nweights without breaking backwards compatibility. As such, when reading the\nstyle of a range of text, the value of `weighted_font_family#font_family`\nwill always be equal to that of `font_family`. However, when writing, if\nboth fields are included in the field mask (either explicitly or through\nthe wildcard `\"*\"`), their values are reconciled as follows:\n\n* If `font_family` is set and `weighted_font_family` is not, the value of\n `font_family` is applied with weight `400` (\"normal\").\n* If both fields are set, the value of `font_family` must match that of\n `weighted_font_family#font_family`. If so, the font family and weight of\n `weighted_font_family` is applied. Otherwise, a 400 bad request error is\n returned.\n* If `weighted_font_family` is set and `font_family` is not, the font\n family and weight of `weighted_font_family` is applied.\n* If neither field is set, the font family and weight of the text inherit\n from the parent. Note that these properties cannot inherit separately\n from each other.\n\nIf an update request specifies values for both `weighted_font_family` and\n`bold`, the `weighted_font_family` is applied first, then `bold`.\n\nIf `weighted_font_family#weight` is not set, it defaults to `400`.\n\nIf `weighted_font_family` is set, then `weighted_font_family#font_family`\nmust also be set with a non-empty value. Otherwise, a 400 bad request error\nis returned."
+ },
+ "smallCaps": {
+ "description": "Whether or not the text is in small capital letters.",
+ "type": "boolean"
+ },
+ "backgroundColor": {
+ "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"
+ },
+ "underline": {
+ "description": "Whether or not the text is underlined.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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."
+ }
+ },
+ "id": "TextStyle",
+ "description": "Represents the styling that can be applied to a TextRun.\n\nIf this text is contained in a shape with a parent placeholder, then these text styles may be\ninherited from the parent. Which text styles are inherited depend on the\nnesting level of lists:\n\n* A text run in a paragraph that is not in a list will inherit its text style\n from the the newline character in the paragraph at the 0 nesting level of\n the list inside the parent placeholder.\n* A text run in a paragraph that is in a list will inherit its text style\n from the newline character in the paragraph at its corresponding nesting\n level of the list inside the parent placeholder.\n\nInherited text styles are represented as unset fields in this message. If\ntext is contained in a shape without a parent placeholder, unsetting these\nfields will revert the style to a value matching the defaults in the Slides\neditor.",
+ "type": "object"
+ },
+ "UpdateVideoPropertiesRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the video the updates are applied to.",
+ "type": "string"
+ },
+ "videoProperties": {
+ "description": "The video properties to update.",
+ "$ref": "VideoProperties"
+ },
+ "fields": {
+ "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",
+ "description": "Update the properties of a Video."
+ },
+ "Request": {
+ "description": "A single kind of update to apply to a presentation.",
+ "type": "object",
+ "properties": {
+ "refreshSheetsChart": {
+ "description": "Refreshes a Google Sheets chart.",
+ "$ref": "RefreshSheetsChartRequest"
+ },
+ "updateTableCellProperties": {
+ "description": "Updates the properties of a TableCell.",
+ "$ref": "UpdateTableCellPropertiesRequest"
+ },
+ "createTable": {
+ "$ref": "CreateTableRequest",
+ "description": "Creates a new table."
+ },
+ "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."
+ },
+ "deleteTableColumn": {
+ "$ref": "DeleteTableColumnRequest",
+ "description": "Deletes a column from a table."
+ },
+ "duplicateObject": {
+ "$ref": "DuplicateObjectRequest",
+ "description": "Duplicates a slide or page element."
+ },
+ "createLine": {
+ "$ref": "CreateLineRequest",
+ "description": "Creates a line."
+ },
+ "updateVideoProperties": {
+ "description": "Updates the properties of a Video.",
+ "$ref": "UpdateVideoPropertiesRequest"
+ },
+ "createImage": {
+ "description": "Creates an image.",
+ "$ref": "CreateImageRequest"
+ },
+ "createParagraphBullets": {
+ "$ref": "CreateParagraphBulletsRequest",
+ "description": "Creates bullets for paragraphs."
+ },
+ "createVideo": {
+ "description": "Creates a video.",
+ "$ref": "CreateVideoRequest"
+ },
+ "replaceAllShapesWithSheetsChart": {
+ "$ref": "ReplaceAllShapesWithSheetsChartRequest",
+ "description": "Replaces all shapes matching some criteria with a Google Sheets chart."
+ },
+ "createSheetsChart": {
+ "$ref": "CreateSheetsChartRequest",
+ "description": "Creates an embedded 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": {
+ "$ref": "ReplaceAllShapesWithImageRequest",
+ "description": "Replaces all shapes matching some criteria with an image."
+ },
+ "replaceAllText": {
+ "description": "Replaces all instances of specified text.",
+ "$ref": "ReplaceAllTextRequest"
+ },
+ "updateImageProperties": {
+ "$ref": "UpdateImagePropertiesRequest",
+ "description": "Updates the properties of an Image."
+ },
+ "insertTableRows": {
+ "description": "Inserts rows into a table.",
+ "$ref": "InsertTableRowsRequest"
+ },
+ "createSlide": {
+ "$ref": "CreateSlideRequest",
+ "description": "Creates a new slide."
+ },
+ "updateLineProperties": {
+ "description": "Updates the properties of a Line.",
+ "$ref": "UpdateLinePropertiesRequest"
+ },
+ "updateSlidesPosition": {
+ "description": "Updates the position of a set of slides in the presentation.",
+ "$ref": "UpdateSlidesPositionRequest"
+ },
+ "deleteTableRow": {
+ "$ref": "DeleteTableRowRequest",
+ "description": "Deletes a row from a table."
+ },
+ "updateShapeProperties": {
+ "$ref": "UpdateShapePropertiesRequest",
+ "description": "Updates the properties of a Shape."
+ },
+ "insertText": {
+ "$ref": "InsertTextRequest",
+ "description": "Inserts text into a shape or table cell."
+ },
+ "deleteText": {
+ "description": "Deletes text from a shape or a table cell.",
+ "$ref": "DeleteTextRequest"
+ },
+ "updatePageProperties": {
+ "description": "Updates the properties of a Page.",
+ "$ref": "UpdatePagePropertiesRequest"
+ },
+ "createShape": {
+ "description": "Creates a new shape.",
+ "$ref": "CreateShapeRequest"
+ },
+ "deleteParagraphBullets": {
+ "$ref": "DeleteParagraphBulletsRequest",
+ "description": "Deletes bullets from paragraphs."
+ },
+ "insertTableColumns": {
+ "$ref": "InsertTableColumnsRequest",
+ "description": "Inserts columns into a table."
+ }
+ },
+ "id": "Request"
+ },
+ "UpdateImagePropertiesRequest": {
+ "description": "Update the properties of an Image.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the image the updates are applied to.",
+ "type": "string"
+ },
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "imageProperties": {
+ "$ref": "ImageProperties",
+ "description": "The image properties to update."
+ }
+ },
+ "id": "UpdateImagePropertiesRequest"
+ },
+ "ParagraphStyle": {
+ "properties": {
+ "indentFirstLine": {
+ "$ref": "Dimension",
+ "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent."
+ },
+ "lineSpacing": {
+ "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent.",
+ "format": "float",
+ "type": "number"
+ },
+ "alignment": {
+ "enumDescriptions": [
+ "The paragraph alignment is inherited from the parent.",
+ "The paragraph is aligned to the start of the line. Left-aligned for\nLTR text, right-aligned otherwise.",
+ "The paragraph is centered.",
+ "The paragraph is aligned to the end of the line. Right-aligned for\nLTR text, left-aligned otherwise.",
+ "The paragraph is justified."
+ ],
+ "enum": [
+ "ALIGNMENT_UNSPECIFIED",
+ "START",
+ "CENTER",
+ "END",
+ "JUSTIFIED"
+ ],
+ "description": "The text alignment for this paragraph.",
+ "type": "string"
+ },
+ "spaceBelow": {
+ "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent.",
+ "$ref": "Dimension"
+ },
+ "direction": {
+ "type": "string",
+ "enumDescriptions": [
+ "The text direction is inherited from the parent.",
+ "The text goes from left to right.",
+ "The text goes from right to left."
+ ],
+ "enum": [
+ "TEXT_DIRECTION_UNSPECIFIED",
+ "LEFT_TO_RIGHT",
+ "RIGHT_TO_LEFT"
+ ],
+ "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT since\ntext direction is not inherited."
+ },
+ "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."
+ }
+ },
+ "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": {
+ "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": {
+ "id": "TableCellProperties",
+ "description": "The properties of the TableCell.",
+ "type": "object",
+ "properties": {
+ "tableCellBackgroundFill": {
+ "$ref": "TableCellBackgroundFill",
+ "description": "The background fill of the table cell. The default fill matches the fill\nfor newly created table cells in the Slides editor."
+ }
+ }
+ },
+ "Outline": {
+ "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
+ "type": "object",
+ "properties": {
+ "outlineFill": {
+ "$ref": "OutlineFill",
+ "description": "The fill of the outline."
+ },
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the outline."
+ },
+ "dashStyle": {
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ],
+ "description": "The dash style of the outline.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ]
+ },
+ "propertyState": {
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The outline property state.\n\nUpdating the the outline on a page element will implicitly update this\nfield to`RENDERED`, unless another value is specified in the same request.\nTo have no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored.",
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ]
+ }
+ },
+ "id": "Outline"
+ },
+ "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"
+ }
+ }
+ },
+ "NotesProperties": {
+ "description": "The properties of Page that are only\nrelevant for pages with page_type NOTES.",
+ "type": "object",
+ "properties": {
+ "speakerNotesObjectId": {
+ "type": "string",
+ "description": "The object ID of the shape on this notes page that contains the speaker\nnotes for the corresponding slide.\nThe actual shape may not always exist on the notes page. Inserting text\nusing this object ID will automatically create the shape. In this case, the\nactual shape may have different object ID. The `GetPresentation` or\n`GetPage` action will always return the latest object ID."
+ }
+ },
+ "id": "NotesProperties"
+ },
+ "ShapeProperties": {
+ "description": "The properties of a Shape.\n\nIf the shape is a placeholder shape as determined by the\nplaceholder field, then these\nproperties may be inherited from a parent placeholder shape.\nDetermining the rendered value of the property depends on the corresponding\nproperty_state field value.",
+ "type": "object",
+ "properties": {
+ "outline": {
+ "$ref": "Outline",
+ "description": "The outline of the shape. If unset, the outline is inherited from a\nparent placeholder if it exists. If the shape has no parent, then the\ndefault outline depends on the shape type, matching the defaults for\nnew shapes created in the Slides editor."
+ },
+ "shapeBackgroundFill": {
+ "$ref": "ShapeBackgroundFill",
+ "description": "The background fill of the shape. If unset, the background fill is\ninherited from a parent placeholder if it exists. If the shape has no\nparent, then the default background fill depends on the shape type,\nmatching the defaults for new shapes created in the Slides editor."
+ },
+ "shadow": {
+ "$ref": "Shadow",
+ "description": "The shadow properties of the shape. If unset, the shadow is inherited from\na parent placeholder if it exists. If the shape has no parent, then the\ndefault shadow matches the defaults for new shapes created in the Slides\neditor. This property is read-only."
+ },
+ "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"
+ },
+ "TableColumnProperties": {
+ "description": "Properties of each column in a table.",
+ "type": "object",
+ "properties": {
+ "columnWidth": {
+ "description": "Width of a column.",
+ "$ref": "Dimension"
+ }
+ },
+ "id": "TableColumnProperties"
+ },
"TableRow": {
"description": "Properties and contents of each row in a table.",
"type": "object",
"properties": {
"rowHeight": {
- "description": "Height of a row.",
- "$ref": "Dimension"
+ "$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.",
@@ -293,31 +624,30 @@
"id": "TableRow"
},
"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": {
- "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table.",
- "$ref": "TableRange"
+ "$ref": "TableRange",
+ "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
},
"tableCellProperties": {
"$ref": "TableCellProperties",
"description": "The table cell properties to update."
+ },
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
}
},
- "id": "UpdateTableCellPropertiesRequest",
- "description": "Update the properties of a TableCell."
+ "id": "UpdateTableCellPropertiesRequest"
},
"CreateSlideRequest": {
- "description": "Creates a new slide.",
"type": "object",
"properties": {
"slideLayoutReference": {
@@ -341,36 +671,36 @@
}
}
},
- "id": "CreateSlideRequest"
+ "id": "CreateSlideRequest",
+ "description": "Creates a new slide."
},
"BatchUpdatePresentationRequest": {
- "description": "Request message for PresentationsService.BatchUpdatePresentation.",
- "type": "object",
"properties": {
- "writeControl": {
- "$ref": "WriteControl",
- "description": "Provides control over how write requests are executed."
- },
"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."
}
},
- "id": "BatchUpdatePresentationRequest"
+ "id": "BatchUpdatePresentationRequest",
+ "description": "Request message for PresentationsService.BatchUpdatePresentation.",
+ "type": "object"
},
"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"
- },
- "description": "The text contents broken down into its component parts, including styling\ninformation. This property is read-only."
+ }
},
"lists": {
"additionalProperties": {
@@ -380,56 +710,57 @@
"type": "object"
}
},
- "id": "TextContent"
+ "id": "TextContent",
+ "description": "The general text content. The text must reside in a compatible shape (e.g.\ntext box or rectangle) or a table cell in a page."
},
"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"
+ "id": "CreateSheetsChartResponse",
+ "description": "The result of creating an embedded Google Sheets chart.",
+ "type": "object"
},
"WriteControl": {
- "description": "Provides control over how write requests are executed.",
"type": "object",
"properties": {
"requiredRevisionId": {
- "type": "string",
- "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error."
+ "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error.",
+ "type": "string"
}
},
- "id": "WriteControl"
+ "id": "WriteControl",
+ "description": "Provides control over how write requests are executed."
},
"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": {
- "description": "The range of text to delete bullets from, based on TextElement indexes.",
- "$ref": "Range"
- },
- "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."
+ "$ref": "Range",
+ "description": "The range of text to delete bullets from, based on TextElement indexes."
}
},
- "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"
+ "id": "DeleteParagraphBulletsRequest"
},
"ParagraphMarker": {
"description": "A TextElement kind that represents the beginning of a new paragraph.",
"type": "object",
"properties": {
"bullet": {
- "description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list.",
- "$ref": "Bullet"
+ "$ref": "Bullet",
+ "description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list."
},
"style": {
"$ref": "ParagraphStyle",
@@ -439,33 +770,38 @@
"id": "ParagraphMarker"
},
"InsertTableColumnsRequest": {
+ "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
+ "type": "object",
"properties": {
+ "tableObjectId": {
+ "description": "The table to insert columns into.",
+ "type": "string"
+ },
"number": {
"description": "The number of columns to be inserted. Maximum 20 per request.",
"format": "int32",
"type": "integer"
},
"cellLocation": {
- "description": "The reference table cell location from which columns will be inserted.\n\nA new column will be inserted to the left (or right) of the column where\nthe reference cell is. If the reference cell is a merged cell, a new\ncolumn will be inserted to the left (or right) of the merged cell.",
- "$ref": "TableCellLocation"
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which columns will be inserted.\n\nA new column will be inserted to the left (or right) of the column where\nthe reference cell is. If the reference cell is a merged cell, a new\ncolumn will be inserted to the left (or right) of the merged cell."
},
"insertRight": {
"description": "Whether to insert new columns to the right of the reference cell location.\n\n- `True`: insert to the right.\n- `False`: insert to the left.",
"type": "boolean"
- },
- "tableObjectId": {
- "description": "The table to insert columns into.",
- "type": "string"
}
},
- "id": "InsertTableColumnsRequest",
- "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
- "type": "object"
+ "id": "InsertTableColumnsRequest"
},
"Thumbnail": {
"description": "The thumbnail of a page.",
"type": "object",
"properties": {
+ "height": {
+ "description": "The positive height in pixels of the thumbnail image.",
+ "format": "int32",
+ "type": "integer"
+ },
"contentUrl": {
"description": "The content URL of the thumbnail image.\n\nThe URL to the image has a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.\nThe mime type of the thumbnail image is the same as specified in the\n`GetPageThumbnailRequest`.",
"type": "string"
@@ -474,17 +810,11 @@
"description": "The positive width in pixels of the thumbnail image.",
"format": "int32",
"type": "integer"
- },
- "height": {
- "description": "The positive height in pixels of the thumbnail image.",
- "format": "int32",
- "type": "integer"
}
},
"id": "Thumbnail"
},
"LayoutPlaceholderIdMapping": {
- "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout.",
"type": "object",
"properties": {
"objectId": {
@@ -492,25 +822,21 @@
"type": "string"
},
"layoutPlaceholder": {
- "$ref": "Placeholder",
- "description": "The placeholder on a layout that will be applied to a slide. Only type and index are needed. For example, a\npredefined `TITLE_AND_BODY` layout may usually have a TITLE placeholder\nwith index 0 and a BODY placeholder with index 0."
+ "description": "The placeholder on a layout that will be applied to a slide. Only type and index are needed. For example, a\npredefined `TITLE_AND_BODY` layout may usually have a TITLE placeholder\nwith index 0 and a BODY placeholder with index 0.",
+ "$ref": "Placeholder"
},
"layoutPlaceholderObjectId": {
- "type": "string",
- "description": "The object ID of the placeholder on a layout that will be applied\nto a slide."
+ "description": "The object ID of the placeholder on a layout that will be applied\nto a slide.",
+ "type": "string"
}
},
- "id": "LayoutPlaceholderIdMapping"
+ "id": "LayoutPlaceholderIdMapping",
+ "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout."
},
"UpdateShapePropertiesRequest": {
- "id": "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."
@@ -519,10 +845,16 @@
"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"
},
"WordArt": {
+ "id": "WordArt",
"description": "A PageElement kind representing\nword art.",
"type": "object",
"properties": {
@@ -530,10 +862,10 @@
"description": "The text rendered as word art.",
"type": "string"
}
- },
- "id": "WordArt"
+ }
},
"Recolor": {
+ "description": "A recolor effect applied on an image.",
"type": "object",
"properties": {
"recolorStops": {
@@ -544,6 +876,8 @@
}
},
"name": {
+ "description": "The name of the recolor effect.\n\nThe name is determined from the `recolor_stops` by matching the gradient\nagainst the colors in the page's current color scheme. This property is\nread-only.",
+ "type": "string",
"enumDescriptions": [
"No recolor effect. The default value.",
"A recolor effect that lightens the image using the page's first available\ncolor from its color scheme.",
@@ -597,25 +931,18 @@
"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"
+ ]
}
},
- "id": "Recolor",
- "description": "A recolor effect applied on an image."
+ "id": "Recolor"
},
"Link": {
"description": "A hypertext link.",
"type": "object",
"properties": {
- "pageObjectId": {
- "type": "string",
- "description": "If set, indicates this is a link to the specific page in this\npresentation with this ID. A page with this ID may not exist."
- },
"url": {
- "type": "string",
- "description": "If set, indicates this is a link to the external web page at this URL."
+ "description": "If set, indicates this is a link to the external web page at this URL.",
+ "type": "string"
},
"relativeLink": {
"enumDescriptions": [
@@ -636,13 +963,39 @@
"type": "string"
},
"slideIndex": {
- "type": "integer",
"description": "If set, indicates this is a link to the slide at this zero-based index\nin the presentation. There may not be a slide at this index.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageObjectId": {
+ "description": "If set, indicates this is a link to the specific page in this\npresentation with this ID. A page with this ID may not exist.",
+ "type": "string"
}
},
"id": "Link"
},
+ "RgbColor": {
+ "description": "An RGB color.",
+ "type": "object",
+ "properties": {
+ "red": {
+ "description": "The red component of the color, from 0.0 to 1.0.",
+ "format": "float",
+ "type": "number"
+ },
+ "green": {
+ "description": "The green component of the color, from 0.0 to 1.0.",
+ "format": "float",
+ "type": "number"
+ },
+ "blue": {
+ "type": "number",
+ "description": "The blue component of the color, from 0.0 to 1.0.",
+ "format": "float"
+ }
+ },
+ "id": "RgbColor"
+ },
"CreateShapeResponse": {
"id": "CreateShapeResponse",
"description": "The result of creating a shape.",
@@ -654,30 +1007,7 @@
}
}
},
- "RgbColor": {
- "properties": {
- "green": {
- "description": "The green component of the color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- },
- "blue": {
- "description": "The blue component of the color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- },
- "red": {
- "description": "The red component of the color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- }
- },
- "id": "RgbColor",
- "description": "An RGB color.",
- "type": "object"
- },
"CreateLineRequest": {
- "description": "Creates a line.",
"type": "object",
"properties": {
"objectId": {
@@ -685,10 +1015,12 @@
"type": "string"
},
"elementProperties": {
- "description": "The element properties for the line.",
- "$ref": "PageElementProperties"
+ "$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.",
@@ -698,23 +1030,22 @@
"STRAIGHT",
"BENT",
"CURVED"
- ],
- "description": "The category of line to be created.",
- "type": "string"
+ ]
}
},
- "id": "CreateLineRequest"
+ "id": "CreateLineRequest",
+ "description": "Creates a line."
},
"CreateSlideResponse": {
- "description": "The result of creating a slide.",
- "type": "object",
"properties": {
"objectId": {
"description": "The object ID of the created slide.",
"type": "string"
}
},
- "id": "CreateSlideResponse"
+ "id": "CreateSlideResponse",
+ "description": "The result of creating a slide.",
+ "type": "object"
},
"CreateShapeRequest": {
"description": "Creates a new shape.",
@@ -725,151 +1056,6 @@
"type": "string"
},
"shapeType": {
- "enumDescriptions": [
- "The shape type that is not predefined.",
- "Text box shape.",
- "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'.",
- "Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'roundRect'",
- "Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse'",
- "Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc'",
- "Bent arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentArrow'",
- "Bent up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentUpArrow'",
- "Bevel shape. Corresponds to ECMA-376 ST_ShapeType 'bevel'",
- "Block arc shape. Corresponds to ECMA-376 ST_ShapeType 'blockArc'",
- "Brace pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracePair'",
- "Bracket pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracketPair'",
- "Can shape. Corresponds to ECMA-376 ST_ShapeType 'can'",
- "Chevron shape. Corresponds to ECMA-376 ST_ShapeType 'chevron'",
- "Chord shape. Corresponds to ECMA-376 ST_ShapeType 'chord'",
- "Cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloud'",
- "Corner shape. Corresponds to ECMA-376 ST_ShapeType 'corner'",
- "Cube shape. Corresponds to ECMA-376 ST_ShapeType 'cube'",
- "Curved down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedDownArrow'",
- "Curved left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedLeftArrow'",
- "Curved right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedRightArrow'",
- "Curved up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedUpArrow'",
- "Decagon shape. Corresponds to ECMA-376 ST_ShapeType 'decagon'",
- "Diagonal stripe shape. Corresponds to ECMA-376 ST_ShapeType 'diagStripe'",
- "Diamond shape. Corresponds to ECMA-376 ST_ShapeType 'diamond'",
- "Dodecagon shape. Corresponds to ECMA-376 ST_ShapeType 'dodecagon'",
- "Donut shape. Corresponds to ECMA-376 ST_ShapeType 'donut'",
- "Double wave shape. Corresponds to ECMA-376 ST_ShapeType 'doubleWave'",
- "Down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'downArrow'",
- "Callout down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'downArrowCallout'",
- "Folded corner shape. Corresponds to ECMA-376 ST_ShapeType 'foldedCorner'",
- "Frame shape. Corresponds to ECMA-376 ST_ShapeType 'frame'",
- "Half frame shape. Corresponds to ECMA-376 ST_ShapeType 'halfFrame'",
- "Heart shape. Corresponds to ECMA-376 ST_ShapeType 'heart'",
- "Heptagon shape. Corresponds to ECMA-376 ST_ShapeType 'heptagon'",
- "Hexagon shape. Corresponds to ECMA-376 ST_ShapeType 'hexagon'",
- "Home plate shape. Corresponds to ECMA-376 ST_ShapeType 'homePlate'",
- "Horizontal scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'horizontalScroll'",
- "Irregular seal 1 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal1'",
- "Irregular seal 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal2'",
- "Left arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftArrow'",
- "Callout left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftArrowCallout'",
- "Left brace shape. Corresponds to ECMA-376 ST_ShapeType 'leftBrace'",
- "Left bracket shape. Corresponds to ECMA-376 ST_ShapeType 'leftBracket'",
- "Left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrow'",
- "Callout left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrowCallout'",
- "Left right up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightUpArrow'",
- "Left up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftUpArrow'",
- "Lightning bolt shape. Corresponds to ECMA-376 ST_ShapeType\n'lightningBolt'",
- "Divide math shape. Corresponds to ECMA-376 ST_ShapeType 'mathDivide'",
- "Equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathEqual'",
- "Minus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMinus'",
- "Multiply math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMultiply'",
- "Not equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathNotEqual'",
- "Plus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathPlus'",
- "Moon shape. Corresponds to ECMA-376 ST_ShapeType 'moon'",
- "No smoking shape. Corresponds to ECMA-376 ST_ShapeType 'noSmoking'",
- "Notched right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'notchedRightArrow'",
- "Octagon shape. Corresponds to ECMA-376 ST_ShapeType 'octagon'",
- "Parallelogram shape. Corresponds to ECMA-376 ST_ShapeType 'parallelogram'",
- "Pentagon shape. Corresponds to ECMA-376 ST_ShapeType 'pentagon'",
- "Pie shape. Corresponds to ECMA-376 ST_ShapeType 'pie'",
- "Plaque shape. Corresponds to ECMA-376 ST_ShapeType 'plaque'",
- "Plus shape. Corresponds to ECMA-376 ST_ShapeType 'plus'",
- "Quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType 'quadArrow'",
- "Callout quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'quadArrowCallout'",
- "Ribbon shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon'",
- "Ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon2'",
- "Right arrow shape. Corresponds to ECMA-376 ST_ShapeType 'rightArrow'",
- "Callout right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'rightArrowCallout'",
- "Right brace shape. Corresponds to ECMA-376 ST_ShapeType 'rightBrace'",
- "Right bracket shape. Corresponds to ECMA-376 ST_ShapeType 'rightBracket'",
- "One round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'round1Rect'",
- "Two diagonal round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2DiagRect'",
- "Two same-side round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2SameRect'",
- "Right triangle shape. Corresponds to ECMA-376 ST_ShapeType 'rtTriangle'",
- "Smiley face shape. Corresponds to ECMA-376 ST_ShapeType 'smileyFace'",
- "One snip corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'snip1Rect'",
- "Two diagonal snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2DiagRect'",
- "Two same-side snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2SameRect'",
- "One snip one round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snipRoundRect'",
- "Ten pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star10'",
- "Twelve pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star12'",
- "Sixteen pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star16'",
- "Twenty four pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star24'",
- "Thirty two pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star32'",
- "Four pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star4'",
- "Five pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star5'",
- "Six pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star6'",
- "Seven pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star7'",
- "Eight pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star8'",
- "Striped right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'stripedRightArrow'",
- "Sun shape. Corresponds to ECMA-376 ST_ShapeType 'sun'",
- "Trapezoid shape. Corresponds to ECMA-376 ST_ShapeType 'trapezoid'",
- "Triangle shape. Corresponds to ECMA-376 ST_ShapeType 'triangle'",
- "Up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upArrow'",
- "Callout up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'upArrowCallout'",
- "Up down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upDownArrow'",
- "U-turn arrow shape. Corresponds to ECMA-376 ST_ShapeType 'uturnArrow'",
- "Vertical scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'verticalScroll'",
- "Wave shape. Corresponds to ECMA-376 ST_ShapeType 'wave'",
- "Callout wedge ellipse shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeEllipseCallout'",
- "Callout wedge rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRectCallout'",
- "Callout wedge round rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRoundRectCallout'",
- "Alternate process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartAlternateProcess'",
- "Collate flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartCollate'",
- "Connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartConnector'",
- "Decision flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDecision'",
- "Delay flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartDelay'",
- "Display flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDisplay'",
- "Document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDocument'",
- "Extract flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartExtract'",
- "Input output flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInputOutput'",
- "Internal storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInternalStorage'",
- "Magnetic disk flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDisk'",
- "Magnetic drum flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDrum'",
- "Magnetic tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticTape'",
- "Manual input flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualInput'",
- "Manual operation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualOperation'",
- "Merge flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartMerge'",
- "Multi-document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMultidocument'",
- "Offline storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOfflineStorage'",
- "Off-page connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOffpageConnector'",
- "Online storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOnlineStorage'",
- "Or flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartOr'",
- "Predefined process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPredefinedProcess'",
- "Preparation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPreparation'",
- "Process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartProcess'",
- "Punched card flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedCard'",
- "Punched tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedTape'",
- "Sort flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartSort'",
- "Summing junction flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartSummingJunction'",
- "Terminator flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartTerminator'",
- "East arrow shape.",
- "Northeast arrow shape.",
- "North arrow shape.",
- "Speech shape.",
- "Star burst shape.",
- "Teardrop shape. Corresponds to ECMA-376 ST_ShapeType 'teardrop'",
- "Ellipse ribbon shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon'",
- "Ellipse ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon2'",
- "Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout'",
- "Custom shape."
- ],
"enum": [
"TYPE_UNSPECIFIED",
"TEXT_BOX",
@@ -1016,7 +1202,152 @@
"CUSTOM"
],
"description": "The shape type.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The shape type that is not predefined.",
+ "Text box shape.",
+ "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'.",
+ "Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'roundRect'",
+ "Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse'",
+ "Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc'",
+ "Bent arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentArrow'",
+ "Bent up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentUpArrow'",
+ "Bevel shape. Corresponds to ECMA-376 ST_ShapeType 'bevel'",
+ "Block arc shape. Corresponds to ECMA-376 ST_ShapeType 'blockArc'",
+ "Brace pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracePair'",
+ "Bracket pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracketPair'",
+ "Can shape. Corresponds to ECMA-376 ST_ShapeType 'can'",
+ "Chevron shape. Corresponds to ECMA-376 ST_ShapeType 'chevron'",
+ "Chord shape. Corresponds to ECMA-376 ST_ShapeType 'chord'",
+ "Cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloud'",
+ "Corner shape. Corresponds to ECMA-376 ST_ShapeType 'corner'",
+ "Cube shape. Corresponds to ECMA-376 ST_ShapeType 'cube'",
+ "Curved down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedDownArrow'",
+ "Curved left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedLeftArrow'",
+ "Curved right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedRightArrow'",
+ "Curved up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedUpArrow'",
+ "Decagon shape. Corresponds to ECMA-376 ST_ShapeType 'decagon'",
+ "Diagonal stripe shape. Corresponds to ECMA-376 ST_ShapeType 'diagStripe'",
+ "Diamond shape. Corresponds to ECMA-376 ST_ShapeType 'diamond'",
+ "Dodecagon shape. Corresponds to ECMA-376 ST_ShapeType 'dodecagon'",
+ "Donut shape. Corresponds to ECMA-376 ST_ShapeType 'donut'",
+ "Double wave shape. Corresponds to ECMA-376 ST_ShapeType 'doubleWave'",
+ "Down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'downArrow'",
+ "Callout down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'downArrowCallout'",
+ "Folded corner shape. Corresponds to ECMA-376 ST_ShapeType 'foldedCorner'",
+ "Frame shape. Corresponds to ECMA-376 ST_ShapeType 'frame'",
+ "Half frame shape. Corresponds to ECMA-376 ST_ShapeType 'halfFrame'",
+ "Heart shape. Corresponds to ECMA-376 ST_ShapeType 'heart'",
+ "Heptagon shape. Corresponds to ECMA-376 ST_ShapeType 'heptagon'",
+ "Hexagon shape. Corresponds to ECMA-376 ST_ShapeType 'hexagon'",
+ "Home plate shape. Corresponds to ECMA-376 ST_ShapeType 'homePlate'",
+ "Horizontal scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'horizontalScroll'",
+ "Irregular seal 1 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal1'",
+ "Irregular seal 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal2'",
+ "Left arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftArrow'",
+ "Callout left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftArrowCallout'",
+ "Left brace shape. Corresponds to ECMA-376 ST_ShapeType 'leftBrace'",
+ "Left bracket shape. Corresponds to ECMA-376 ST_ShapeType 'leftBracket'",
+ "Left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrow'",
+ "Callout left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrowCallout'",
+ "Left right up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightUpArrow'",
+ "Left up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftUpArrow'",
+ "Lightning bolt shape. Corresponds to ECMA-376 ST_ShapeType\n'lightningBolt'",
+ "Divide math shape. Corresponds to ECMA-376 ST_ShapeType 'mathDivide'",
+ "Equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathEqual'",
+ "Minus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMinus'",
+ "Multiply math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMultiply'",
+ "Not equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathNotEqual'",
+ "Plus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathPlus'",
+ "Moon shape. Corresponds to ECMA-376 ST_ShapeType 'moon'",
+ "No smoking shape. Corresponds to ECMA-376 ST_ShapeType 'noSmoking'",
+ "Notched right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'notchedRightArrow'",
+ "Octagon shape. Corresponds to ECMA-376 ST_ShapeType 'octagon'",
+ "Parallelogram shape. Corresponds to ECMA-376 ST_ShapeType 'parallelogram'",
+ "Pentagon shape. Corresponds to ECMA-376 ST_ShapeType 'pentagon'",
+ "Pie shape. Corresponds to ECMA-376 ST_ShapeType 'pie'",
+ "Plaque shape. Corresponds to ECMA-376 ST_ShapeType 'plaque'",
+ "Plus shape. Corresponds to ECMA-376 ST_ShapeType 'plus'",
+ "Quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType 'quadArrow'",
+ "Callout quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'quadArrowCallout'",
+ "Ribbon shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon'",
+ "Ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon2'",
+ "Right arrow shape. Corresponds to ECMA-376 ST_ShapeType 'rightArrow'",
+ "Callout right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'rightArrowCallout'",
+ "Right brace shape. Corresponds to ECMA-376 ST_ShapeType 'rightBrace'",
+ "Right bracket shape. Corresponds to ECMA-376 ST_ShapeType 'rightBracket'",
+ "One round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'round1Rect'",
+ "Two diagonal round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2DiagRect'",
+ "Two same-side round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2SameRect'",
+ "Right triangle shape. Corresponds to ECMA-376 ST_ShapeType 'rtTriangle'",
+ "Smiley face shape. Corresponds to ECMA-376 ST_ShapeType 'smileyFace'",
+ "One snip corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'snip1Rect'",
+ "Two diagonal snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2DiagRect'",
+ "Two same-side snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2SameRect'",
+ "One snip one round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snipRoundRect'",
+ "Ten pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star10'",
+ "Twelve pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star12'",
+ "Sixteen pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star16'",
+ "Twenty four pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star24'",
+ "Thirty two pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star32'",
+ "Four pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star4'",
+ "Five pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star5'",
+ "Six pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star6'",
+ "Seven pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star7'",
+ "Eight pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star8'",
+ "Striped right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'stripedRightArrow'",
+ "Sun shape. Corresponds to ECMA-376 ST_ShapeType 'sun'",
+ "Trapezoid shape. Corresponds to ECMA-376 ST_ShapeType 'trapezoid'",
+ "Triangle shape. Corresponds to ECMA-376 ST_ShapeType 'triangle'",
+ "Up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upArrow'",
+ "Callout up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'upArrowCallout'",
+ "Up down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upDownArrow'",
+ "U-turn arrow shape. Corresponds to ECMA-376 ST_ShapeType 'uturnArrow'",
+ "Vertical scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'verticalScroll'",
+ "Wave shape. Corresponds to ECMA-376 ST_ShapeType 'wave'",
+ "Callout wedge ellipse shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeEllipseCallout'",
+ "Callout wedge rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRectCallout'",
+ "Callout wedge round rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRoundRectCallout'",
+ "Alternate process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartAlternateProcess'",
+ "Collate flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartCollate'",
+ "Connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartConnector'",
+ "Decision flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDecision'",
+ "Delay flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartDelay'",
+ "Display flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDisplay'",
+ "Document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDocument'",
+ "Extract flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartExtract'",
+ "Input output flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInputOutput'",
+ "Internal storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInternalStorage'",
+ "Magnetic disk flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDisk'",
+ "Magnetic drum flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDrum'",
+ "Magnetic tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticTape'",
+ "Manual input flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualInput'",
+ "Manual operation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualOperation'",
+ "Merge flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartMerge'",
+ "Multi-document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMultidocument'",
+ "Offline storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOfflineStorage'",
+ "Off-page connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOffpageConnector'",
+ "Online storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOnlineStorage'",
+ "Or flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartOr'",
+ "Predefined process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPredefinedProcess'",
+ "Preparation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPreparation'",
+ "Process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartProcess'",
+ "Punched card flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedCard'",
+ "Punched tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedTape'",
+ "Sort flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartSort'",
+ "Summing junction flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartSummingJunction'",
+ "Terminator flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartTerminator'",
+ "East arrow shape.",
+ "Northeast arrow shape.",
+ "North arrow shape.",
+ "Speech shape.",
+ "Star burst shape.",
+ "Teardrop shape. Corresponds to ECMA-376 ST_ShapeType 'teardrop'",
+ "Ellipse ribbon shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon'",
+ "Ellipse ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon2'",
+ "Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout'",
+ "Custom shape."
+ ]
},
"elementProperties": {
"$ref": "PageElementProperties",
@@ -1050,51 +1381,45 @@
"type": "string"
},
"videoProperties": {
- "description": "The properties of the video.",
- "$ref": "VideoProperties"
+ "$ref": "VideoProperties",
+ "description": "The properties of the video."
}
},
"id": "Video"
},
"PageProperties": {
+ "description": "The properties of the Page.\n\nThe page will inherit properties from the parent page. Depending on the page\ntype the hierarchy is defined in either\nSlideProperties or\nLayoutProperties.",
+ "type": "object",
"properties": {
"pageBackgroundFill": {
- "$ref": "PageBackgroundFill",
- "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor."
+ "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor.",
+ "$ref": "PageBackgroundFill"
},
"colorScheme": {
- "$ref": "ColorScheme",
- "description": "The color scheme of the page. If unset, the color scheme is inherited from\na parent page. If the page has no parent, the color scheme uses a default\nSlides color scheme. This field is read-only."
+ "description": "The color scheme of the page. If unset, the color scheme is inherited from\na parent page. If the page has no parent, the color scheme uses a default\nSlides color scheme. This field is read-only.",
+ "$ref": "ColorScheme"
}
},
- "id": "PageProperties",
- "description": "The properties of the Page.\n\nThe page will inherit properties from the parent page. Depending on the page\ntype the hierarchy is defined in either\nSlideProperties or\nLayoutProperties.",
- "type": "object"
+ "id": "PageProperties"
},
"NestingLevel": {
+ "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting.",
+ "type": "object",
"properties": {
"bulletStyle": {
"$ref": "TextStyle",
"description": "The style of a bullet at this level of nesting."
}
},
- "id": "NestingLevel",
- "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting.",
- "type": "object"
+ "id": "NestingLevel"
},
"TableCell": {
+ "description": "Properties and contents of each table cell.",
+ "type": "object",
"properties": {
- "text": {
- "description": "The text content of the cell.",
- "$ref": "TextContent"
- },
- "tableCellProperties": {
- "description": "The properties of the table cell.",
- "$ref": "TableCellProperties"
- },
"location": {
- "description": "The location of the cell within the table.",
- "$ref": "TableCellLocation"
+ "$ref": "TableCellLocation",
+ "description": "The location of the cell within the table."
},
"rowSpan": {
"description": "Row span of the cell.",
@@ -1105,22 +1430,28 @@
"description": "Column span of the cell.",
"format": "int32",
"type": "integer"
+ },
+ "text": {
+ "description": "The text content of the cell.",
+ "$ref": "TextContent"
+ },
+ "tableCellProperties": {
+ "$ref": "TableCellProperties",
+ "description": "The properties of the table cell."
}
},
- "id": "TableCell",
- "description": "Properties and contents of each table cell.",
- "type": "object"
+ "id": "TableCell"
},
"UpdateLinePropertiesRequest": {
"properties": {
"lineProperties": {
- "description": "The line properties to update.",
- "$ref": "LineProperties"
+ "$ref": "LineProperties",
+ "description": "The line properties to update."
},
"fields": {
- "type": "string",
"description": "The fields that should be updated.\n\nAt least one field must be specified. The root `lineProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the line solid fill color, set `fields` to\n`\"lineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask"
+ "format": "google-fieldmask",
+ "type": "string"
},
"objectId": {
"description": "The object ID of the line the update is applied to.",
@@ -1131,50 +1462,50 @@
"description": "Updates the properties of a Line.",
"type": "object"
},
- "TableCellBackgroundFill": {
- "description": "The table cell background fill.",
- "type": "object",
- "properties": {
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- },
- "propertyState": {
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The background fill property state.\n\nUpdating the the fill on a table cell will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no fill on a table cell, set this field to `NOT_RENDERED`. In this\ncase, any other fill fields set in the same request will be ignored.",
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ]
- }
- },
- "id": "TableCellBackgroundFill"
- },
"UpdateSlidesPositionRequest": {
"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"
}
+ },
+ "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",
"description": "Updates the position of slides in the presentation.",
"type": "object"
},
+ "TableCellBackgroundFill": {
+ "description": "The table cell background fill.",
+ "type": "object",
+ "properties": {
+ "propertyState": {
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ],
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The background fill property state.\n\nUpdating the 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": {
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
+ }
+ },
+ "id": "TableCellBackgroundFill"
+ },
"UpdatePagePropertiesRequest": {
"type": "object",
"properties": {
@@ -1214,9 +1545,9 @@
"type": "object",
"properties": {
"index": {
- "type": "integer",
"description": "The index of the placeholder. If the same placeholder types are present in\nthe same page, they would have different index values.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"type": {
"enum": [
@@ -1293,6 +1624,13 @@
"description": "The text that will replace the matched text.",
"type": "string"
},
+ "pageObjectIds": {
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes master,\nor if a page with that object ID doesn't exist in the presentation.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"containsText": {
"$ref": "SubstringMatchCriteria",
"description": "Finds text in a shape matching this substring."
@@ -1301,25 +1639,19 @@
"id": "ReplaceAllTextRequest"
},
"Page": {
- "description": "A page in a presentation.",
- "type": "object",
"properties": {
- "layoutProperties": {
- "description": "Layout specific properties. Only set if page_type = LAYOUT.",
- "$ref": "LayoutProperties"
+ "pageElements": {
+ "description": "The page elements rendered on the page.",
+ "type": "array",
+ "items": {
+ "$ref": "PageElement"
+ }
},
"notesProperties": {
"$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": [
@@ -1328,40 +1660,44 @@
"A layout page.",
"A notes page.",
"A notes master page."
+ ],
+ "enum": [
+ "SLIDE",
+ "MASTER",
+ "LAYOUT",
+ "NOTES",
+ "NOTES_MASTER"
]
},
- "pageElements": {
- "description": "The page elements rendered on the page.",
- "type": "array",
- "items": {
- "$ref": "PageElement"
- }
+ "pageProperties": {
+ "description": "The properties of the page.",
+ "$ref": "PageProperties"
},
"slideProperties": {
- "description": "Slide specific properties. Only set if page_type = SLIDE.",
- "$ref": "SlideProperties"
- },
- "pageProperties": {
- "$ref": "PageProperties",
- "description": "The properties of the page."
+ "$ref": "SlideProperties",
+ "description": "Slide specific properties. Only set if page_type = SLIDE."
},
"objectId": {
"description": "The object ID for this page. Object IDs used by\nPage and\nPageElement share the same namespace.",
"type": "string"
},
"revisionId": {
- "description": "The revision ID of the presentation containing this page. Can be used in\nupdate requests to assert that the presentation revision hasn't changed\nsince the last read operation. Only populated if the user has edit access\nto the presentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.",
- "type": "string"
+ "type": "string",
+ "description": "The revision ID of the presentation containing this page. Can be used in\nupdate requests to assert that the presentation revision hasn't changed\nsince the last read operation. Only populated if the user has edit access\nto the presentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes."
+ },
+ "layoutProperties": {
+ "$ref": "LayoutProperties",
+ "description": "Layout specific properties. Only set if page_type = LAYOUT."
}
},
- "id": "Page"
+ "id": "Page",
+ "description": "A page in a presentation.",
+ "type": "object"
},
"ShapeBackgroundFill": {
+ "description": "The shape background fill.",
+ "type": "object",
"properties": {
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- },
"propertyState": {
"enumDescriptions": [
"If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
@@ -1375,11 +1711,13 @@
],
"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"
+ },
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
}
},
- "id": "ShapeBackgroundFill",
- "description": "The shape background fill.",
- "type": "object"
+ "id": "ShapeBackgroundFill"
},
"CropProperties": {
"description": "The crop properties of an object enclosed in a container. For example, an\nImage.\n\nThe crop properties is represented by the offsets of four edges which define\na crop rectangle. The offsets are measured in percentage from the\ncorresponding edges of the object's original bounding rectangle towards\ninside, relative to the object's original dimensions.\n\n- If the offset is in the interval (0, 1), the corresponding edge of crop\nrectangle is positioned inside of the object's original bounding rectangle.\n- If the offset is negative or greater than 1, the corresponding edge of crop\nrectangle is positioned outside of the object's original bounding rectangle.\n- If the left edge of the crop rectangle is on the right side of its right\nedge, the object will be flipped horizontally.\n- If the top edge of the crop rectangle is below its bottom edge, the object\nwill be flipped vertically.\n- If all offsets and rotation angle is 0, the object is not cropped.\n\nAfter cropping, the content in the crop rectangle will be stretched to fit\nits container.",
@@ -1417,15 +1755,6 @@
"description": "Replaces all shapes that match the given criteria with the provided Google\nSheets chart. The chart will be scaled and centered to fit within the bounds\nof the original shape.\n\nNOTE: Replacing shapes with a chart requires at least one of the\nspreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.",
"type": "object",
"properties": {
- "containsText": {
- "$ref": "SubstringMatchCriteria",
- "description": "The criteria that the shapes must match in order to be replaced. The\nrequest will replace all of the shapes that contain the given text."
- },
- "chartId": {
- "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
- "format": "int32",
- "type": "integer"
- },
"spreadsheetId": {
"description": "The ID of the Google Sheets spreadsheet that contains the chart.",
"type": "string"
@@ -1441,44 +1770,28 @@
"The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
"Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
]
+ },
+ "containsText": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "The criteria that the shapes must match in order to be replaced. The\nrequest will replace all of the shapes that contain the given text."
+ },
+ "chartId": {
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageObjectIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation."
}
},
"id": "ReplaceAllShapesWithSheetsChartRequest"
},
- "Range": {
- "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.",
- "type": "object",
- "properties": {
- "startIndex": {
- "description": "The optional zero-based index of the beginning of the collection.\nRequired for `SPECIFIC_RANGE` and `FROM_START_INDEX` ranges.",
- "format": "int32",
- "type": "integer"
- },
- "endIndex": {
- "description": "The optional zero-based index of the end of the collection.\nRequired for `SPECIFIC_RANGE` delete mode.",
- "format": "int32",
- "type": "integer"
- },
- "type": {
- "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."
- ],
- "enum": [
- "RANGE_TYPE_UNSPECIFIED",
- "FIXED_RANGE",
- "FROM_START_INDEX",
- "ALL"
- ]
- }
- },
- "id": "Range"
- },
"ColorStop": {
+ "type": "object",
"properties": {
"color": {
"description": "The color of the gradient stop.",
@@ -1496,8 +1809,40 @@
}
},
"id": "ColorStop",
- "description": "A color and position in a gradient band.",
- "type": "object"
+ "description": "A color and position in a gradient band."
+ },
+ "Range": {
+ "id": "Range",
+ "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.",
+ "type": "object",
+ "properties": {
+ "startIndex": {
+ "type": "integer",
+ "description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges.",
+ "format": "int32"
+ },
+ "endIndex": {
+ "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unspecified range type. This value must not be used.",
+ "A fixed range. Both the `start_index` and\n`end_index` must be specified.",
+ "Starts the range at `start_index` and continues until the\nend of the collection. The `end_index` must not be specified.",
+ "Sets the range to be the whole length of the collection. Both the\n`start_index` and the `end_index` must not be\nspecified."
+ ],
+ "enum": [
+ "RANGE_TYPE_UNSPECIFIED",
+ "FIXED_RANGE",
+ "FROM_START_INDEX",
+ "ALL"
+ ],
+ "description": "The type of range.",
+ "type": "string"
+ }
+ }
},
"CreateVideoRequest": {
"description": "Creates a video.",
@@ -1508,20 +1853,20 @@
"type": "string"
},
"source": {
- "enumDescriptions": [
- "The video source is unspecified.",
- "The video source is YouTube."
- ],
"enum": [
"SOURCE_UNSPECIFIED",
"YOUTUBE"
],
"description": "The video source.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The video source is unspecified.",
+ "The video source is YouTube."
+ ]
},
"elementProperties": {
- "description": "The element properties for the video.",
- "$ref": "PageElementProperties"
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the video."
},
"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.",
@@ -1542,6 +1887,7 @@
"id": "DuplicateObjectResponse"
},
"ReplaceAllShapesWithImageRequest": {
+ "description": "Replaces all shapes that match the given criteria with the provided image.",
"type": "object",
"properties": {
"imageUrl": {
@@ -1561,18 +1907,26 @@
]
},
"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"
+ },
+ "pageObjectIds": {
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "ReplaceAllShapesWithImageRequest",
- "description": "Replaces all shapes that match the given criteria with the provided image."
+ "id": "ReplaceAllShapesWithImageRequest"
},
"Shadow": {
+ "description": "The shadow properties of a page element.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
+ "type": "object",
"properties": {
- "transform": {
- "$ref": "AffineTransform",
- "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position."
+ "blurRadius": {
+ "$ref": "Dimension",
+ "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes."
},
"type": {
"type": "string",
@@ -1586,8 +1940,11 @@
],
"description": "The type of the shadow."
},
+ "transform": {
+ "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position.",
+ "$ref": "AffineTransform"
+ },
"alignment": {
- "description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow.",
"type": "string",
"enumDescriptions": [
"Unspecified.",
@@ -1612,12 +1969,13 @@
"BOTTOM_LEFT",
"BOTTOM_CENTER",
"BOTTOM_RIGHT"
- ]
+ ],
+ "description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow."
},
"alpha": {
- "type": "number",
"description": "The alpha of the shadow's color, from 0.0 to 1.0.",
- "format": "float"
+ "format": "float",
+ "type": "number"
},
"color": {
"description": "The shadow color value.",
@@ -1640,17 +1998,12 @@
],
"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"
- },
- "blurRadius": {
- "$ref": "Dimension",
- "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes."
}
},
- "id": "Shadow",
- "description": "The shadow properties of a page element.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
- "type": "object"
+ "id": "Shadow"
},
"DeleteTableRowRequest": {
+ "description": "Deletes a row from a table.",
"type": "object",
"properties": {
"cellLocation": {
@@ -1662,8 +2015,7 @@
"type": "string"
}
},
- "id": "DeleteTableRowRequest",
- "description": "Deletes a row from a table."
+ "id": "DeleteTableRowRequest"
},
"Bullet": {
"description": "Describes the bullet of a paragraph.",
@@ -1679,8 +2031,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.",
@@ -1694,31 +2046,13 @@
"type": "object",
"properties": {
"solidFill": {
- "description": "Solid color fill.",
- "$ref": "SolidFill"
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
}
},
"id": "OutlineFill"
},
- "TableCellLocation": {
- "type": "object",
- "properties": {
- "rowIndex": {
- "type": "integer",
- "description": "The 0-based row index.",
- "format": "int32"
- },
- "columnIndex": {
- "description": "The 0-based column index.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TableCellLocation",
- "description": "A location of a single table cell within a table."
- },
"CreateLineResponse": {
- "id": "CreateLineResponse",
"description": "The result of creating a line.",
"type": "object",
"properties": {
@@ -1726,16 +2060,34 @@
"description": "The object ID of the created line.",
"type": "string"
}
- }
+ },
+ "id": "CreateLineResponse"
+ },
+ "TableCellLocation": {
+ "description": "A location of a single table cell within a table.",
+ "type": "object",
+ "properties": {
+ "rowIndex": {
+ "description": "The 0-based row index.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "columnIndex": {
+ "description": "The 0-based column index.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TableCellLocation"
},
"ReplaceAllTextResponse": {
"description": "The result of replacing text.",
"type": "object",
"properties": {
"occurrencesChanged": {
+ "type": "integer",
"description": "The number of occurrences changed by replacing all text.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
"id": "ReplaceAllTextResponse"
@@ -1744,48 +2096,194 @@
"description": "Updates the styling for all of the paragraphs within a Shape or Table that\noverlap with the given text index range.",
"type": "object",
"properties": {
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the cell in the table containing the paragraph(s) to\nstyle. If `object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
+ },
+ "style": {
+ "description": "The paragraph's style.",
+ "$ref": "ParagraphStyle"
+ },
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the paragraph alignment, set `fields` to\n`\"alignment\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
"objectId": {
"description": "The object ID of the shape or table with the text to be styled.",
"type": "string"
},
"textRange": {
- "$ref": "Range",
- "description": "The range of text containing the paragraph(s) to style."
- },
- "cellLocation": {
- "description": "The location of the cell in the table containing the paragraph(s) to\nstyle. If `object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not.",
- "$ref": "TableCellLocation"
- },
- "style": {
- "$ref": "ParagraphStyle",
- "description": "The paragraph's style."
- },
- "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 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"
+ "description": "The range of text containing the paragraph(s) to style.",
+ "$ref": "Range"
}
},
"id": "UpdateParagraphStyleRequest"
},
"ColorScheme": {
+ "description": "The palette of predefined colors for a page.",
+ "type": "object",
"properties": {
"colors": {
- "description": "The ThemeColorType and corresponding concrete color pairs.",
"type": "array",
"items": {
"$ref": "ThemeColorPair"
- }
+ },
+ "description": "The ThemeColorType and corresponding concrete color pairs."
}
},
- "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": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TEXT_BOX",
+ "RECTANGLE",
+ "ROUND_RECTANGLE",
+ "ELLIPSE",
+ "ARC",
+ "BENT_ARROW",
+ "BENT_UP_ARROW",
+ "BEVEL",
+ "BLOCK_ARC",
+ "BRACE_PAIR",
+ "BRACKET_PAIR",
+ "CAN",
+ "CHEVRON",
+ "CHORD",
+ "CLOUD",
+ "CORNER",
+ "CUBE",
+ "CURVED_DOWN_ARROW",
+ "CURVED_LEFT_ARROW",
+ "CURVED_RIGHT_ARROW",
+ "CURVED_UP_ARROW",
+ "DECAGON",
+ "DIAGONAL_STRIPE",
+ "DIAMOND",
+ "DODECAGON",
+ "DONUT",
+ "DOUBLE_WAVE",
+ "DOWN_ARROW",
+ "DOWN_ARROW_CALLOUT",
+ "FOLDED_CORNER",
+ "FRAME",
+ "HALF_FRAME",
+ "HEART",
+ "HEPTAGON",
+ "HEXAGON",
+ "HOME_PLATE",
+ "HORIZONTAL_SCROLL",
+ "IRREGULAR_SEAL_1",
+ "IRREGULAR_SEAL_2",
+ "LEFT_ARROW",
+ "LEFT_ARROW_CALLOUT",
+ "LEFT_BRACE",
+ "LEFT_BRACKET",
+ "LEFT_RIGHT_ARROW",
+ "LEFT_RIGHT_ARROW_CALLOUT",
+ "LEFT_RIGHT_UP_ARROW",
+ "LEFT_UP_ARROW",
+ "LIGHTNING_BOLT",
+ "MATH_DIVIDE",
+ "MATH_EQUAL",
+ "MATH_MINUS",
+ "MATH_MULTIPLY",
+ "MATH_NOT_EQUAL",
+ "MATH_PLUS",
+ "MOON",
+ "NO_SMOKING",
+ "NOTCHED_RIGHT_ARROW",
+ "OCTAGON",
+ "PARALLELOGRAM",
+ "PENTAGON",
+ "PIE",
+ "PLAQUE",
+ "PLUS",
+ "QUAD_ARROW",
+ "QUAD_ARROW_CALLOUT",
+ "RIBBON",
+ "RIBBON_2",
+ "RIGHT_ARROW",
+ "RIGHT_ARROW_CALLOUT",
+ "RIGHT_BRACE",
+ "RIGHT_BRACKET",
+ "ROUND_1_RECTANGLE",
+ "ROUND_2_DIAGONAL_RECTANGLE",
+ "ROUND_2_SAME_RECTANGLE",
+ "RIGHT_TRIANGLE",
+ "SMILEY_FACE",
+ "SNIP_1_RECTANGLE",
+ "SNIP_2_DIAGONAL_RECTANGLE",
+ "SNIP_2_SAME_RECTANGLE",
+ "SNIP_ROUND_RECTANGLE",
+ "STAR_10",
+ "STAR_12",
+ "STAR_16",
+ "STAR_24",
+ "STAR_32",
+ "STAR_4",
+ "STAR_5",
+ "STAR_6",
+ "STAR_7",
+ "STAR_8",
+ "STRIPED_RIGHT_ARROW",
+ "SUN",
+ "TRAPEZOID",
+ "TRIANGLE",
+ "UP_ARROW",
+ "UP_ARROW_CALLOUT",
+ "UP_DOWN_ARROW",
+ "UTURN_ARROW",
+ "VERTICAL_SCROLL",
+ "WAVE",
+ "WEDGE_ELLIPSE_CALLOUT",
+ "WEDGE_RECTANGLE_CALLOUT",
+ "WEDGE_ROUND_RECTANGLE_CALLOUT",
+ "FLOW_CHART_ALTERNATE_PROCESS",
+ "FLOW_CHART_COLLATE",
+ "FLOW_CHART_CONNECTOR",
+ "FLOW_CHART_DECISION",
+ "FLOW_CHART_DELAY",
+ "FLOW_CHART_DISPLAY",
+ "FLOW_CHART_DOCUMENT",
+ "FLOW_CHART_EXTRACT",
+ "FLOW_CHART_INPUT_OUTPUT",
+ "FLOW_CHART_INTERNAL_STORAGE",
+ "FLOW_CHART_MAGNETIC_DISK",
+ "FLOW_CHART_MAGNETIC_DRUM",
+ "FLOW_CHART_MAGNETIC_TAPE",
+ "FLOW_CHART_MANUAL_INPUT",
+ "FLOW_CHART_MANUAL_OPERATION",
+ "FLOW_CHART_MERGE",
+ "FLOW_CHART_MULTIDOCUMENT",
+ "FLOW_CHART_OFFLINE_STORAGE",
+ "FLOW_CHART_OFFPAGE_CONNECTOR",
+ "FLOW_CHART_ONLINE_STORAGE",
+ "FLOW_CHART_OR",
+ "FLOW_CHART_PREDEFINED_PROCESS",
+ "FLOW_CHART_PREPARATION",
+ "FLOW_CHART_PROCESS",
+ "FLOW_CHART_PUNCHED_CARD",
+ "FLOW_CHART_PUNCHED_TAPE",
+ "FLOW_CHART_SORT",
+ "FLOW_CHART_SUMMING_JUNCTION",
+ "FLOW_CHART_TERMINATOR",
+ "ARROW_EAST",
+ "ARROW_NORTH_EAST",
+ "ARROW_NORTH",
+ "SPEECH",
+ "STARBURST",
+ "TEARDROP",
+ "ELLIPSE_RIBBON",
+ "ELLIPSE_RIBBON_2",
+ "CLOUD_CALLOUT",
+ "CUSTOM"
+ ],
"description": "The type of the shape.",
"type": "string",
"enumDescriptions": [
@@ -1932,151 +2430,6 @@
"Ellipse ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon2'",
"Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout'",
"Custom shape."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TEXT_BOX",
- "RECTANGLE",
- "ROUND_RECTANGLE",
- "ELLIPSE",
- "ARC",
- "BENT_ARROW",
- "BENT_UP_ARROW",
- "BEVEL",
- "BLOCK_ARC",
- "BRACE_PAIR",
- "BRACKET_PAIR",
- "CAN",
- "CHEVRON",
- "CHORD",
- "CLOUD",
- "CORNER",
- "CUBE",
- "CURVED_DOWN_ARROW",
- "CURVED_LEFT_ARROW",
- "CURVED_RIGHT_ARROW",
- "CURVED_UP_ARROW",
- "DECAGON",
- "DIAGONAL_STRIPE",
- "DIAMOND",
- "DODECAGON",
- "DONUT",
- "DOUBLE_WAVE",
- "DOWN_ARROW",
- "DOWN_ARROW_CALLOUT",
- "FOLDED_CORNER",
- "FRAME",
- "HALF_FRAME",
- "HEART",
- "HEPTAGON",
- "HEXAGON",
- "HOME_PLATE",
- "HORIZONTAL_SCROLL",
- "IRREGULAR_SEAL_1",
- "IRREGULAR_SEAL_2",
- "LEFT_ARROW",
- "LEFT_ARROW_CALLOUT",
- "LEFT_BRACE",
- "LEFT_BRACKET",
- "LEFT_RIGHT_ARROW",
- "LEFT_RIGHT_ARROW_CALLOUT",
- "LEFT_RIGHT_UP_ARROW",
- "LEFT_UP_ARROW",
- "LIGHTNING_BOLT",
- "MATH_DIVIDE",
- "MATH_EQUAL",
- "MATH_MINUS",
- "MATH_MULTIPLY",
- "MATH_NOT_EQUAL",
- "MATH_PLUS",
- "MOON",
- "NO_SMOKING",
- "NOTCHED_RIGHT_ARROW",
- "OCTAGON",
- "PARALLELOGRAM",
- "PENTAGON",
- "PIE",
- "PLAQUE",
- "PLUS",
- "QUAD_ARROW",
- "QUAD_ARROW_CALLOUT",
- "RIBBON",
- "RIBBON_2",
- "RIGHT_ARROW",
- "RIGHT_ARROW_CALLOUT",
- "RIGHT_BRACE",
- "RIGHT_BRACKET",
- "ROUND_1_RECTANGLE",
- "ROUND_2_DIAGONAL_RECTANGLE",
- "ROUND_2_SAME_RECTANGLE",
- "RIGHT_TRIANGLE",
- "SMILEY_FACE",
- "SNIP_1_RECTANGLE",
- "SNIP_2_DIAGONAL_RECTANGLE",
- "SNIP_2_SAME_RECTANGLE",
- "SNIP_ROUND_RECTANGLE",
- "STAR_10",
- "STAR_12",
- "STAR_16",
- "STAR_24",
- "STAR_32",
- "STAR_4",
- "STAR_5",
- "STAR_6",
- "STAR_7",
- "STAR_8",
- "STRIPED_RIGHT_ARROW",
- "SUN",
- "TRAPEZOID",
- "TRIANGLE",
- "UP_ARROW",
- "UP_ARROW_CALLOUT",
- "UP_DOWN_ARROW",
- "UTURN_ARROW",
- "VERTICAL_SCROLL",
- "WAVE",
- "WEDGE_ELLIPSE_CALLOUT",
- "WEDGE_RECTANGLE_CALLOUT",
- "WEDGE_ROUND_RECTANGLE_CALLOUT",
- "FLOW_CHART_ALTERNATE_PROCESS",
- "FLOW_CHART_COLLATE",
- "FLOW_CHART_CONNECTOR",
- "FLOW_CHART_DECISION",
- "FLOW_CHART_DELAY",
- "FLOW_CHART_DISPLAY",
- "FLOW_CHART_DOCUMENT",
- "FLOW_CHART_EXTRACT",
- "FLOW_CHART_INPUT_OUTPUT",
- "FLOW_CHART_INTERNAL_STORAGE",
- "FLOW_CHART_MAGNETIC_DISK",
- "FLOW_CHART_MAGNETIC_DRUM",
- "FLOW_CHART_MAGNETIC_TAPE",
- "FLOW_CHART_MANUAL_INPUT",
- "FLOW_CHART_MANUAL_OPERATION",
- "FLOW_CHART_MERGE",
- "FLOW_CHART_MULTIDOCUMENT",
- "FLOW_CHART_OFFLINE_STORAGE",
- "FLOW_CHART_OFFPAGE_CONNECTOR",
- "FLOW_CHART_ONLINE_STORAGE",
- "FLOW_CHART_OR",
- "FLOW_CHART_PREDEFINED_PROCESS",
- "FLOW_CHART_PREPARATION",
- "FLOW_CHART_PROCESS",
- "FLOW_CHART_PUNCHED_CARD",
- "FLOW_CHART_PUNCHED_TAPE",
- "FLOW_CHART_SORT",
- "FLOW_CHART_SUMMING_JUNCTION",
- "FLOW_CHART_TERMINATOR",
- "ARROW_EAST",
- "ARROW_NORTH_EAST",
- "ARROW_NORTH",
- "SPEECH",
- "STARBURST",
- "TEARDROP",
- "ELLIPSE_RIBBON",
- "ELLIPSE_RIBBON_2",
- "CLOUD_CALLOUT",
- "CUSTOM"
]
},
"text": {
@@ -2084,19 +2437,17 @@
"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": {
- "description": "The properties of the shape.",
- "$ref": "ShapeProperties"
+ "$ref": "ShapeProperties",
+ "description": "The properties of the shape."
}
},
- "id": "Shape",
- "description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification."
+ "id": "Shape"
},
"Image": {
- "type": "object",
"properties": {
"imageProperties": {
"$ref": "ImageProperties",
@@ -2108,12 +2459,52 @@
}
},
"id": "Image",
- "description": "A PageElement kind representing an\nimage."
+ "description": "A PageElement kind representing an\nimage.",
+ "type": "object"
+ },
+ "InsertTextRequest": {
+ "description": "Inserts text into a shape or a table cell.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the shape or table where the text will be inserted.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The text to be inserted.\n\nInserting a newline character will implicitly create a new\nParagraphMarker at that index.\nThe paragraph style of the new paragraph will be copied from the paragraph\nat the current insertion index, including lists and bullets.\n\nText styles for inserted text will be determined automatically, generally\npreserving the styling of neighboring text. In most cases, the text will be\nadded to the TextRun that exists at the\ninsertion index.\n\nSome control characters (U+0000-U+0008, U+000C-U+001F) and characters\nfrom the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF)\nwill be stripped out of the inserted text.",
+ "type": "string"
+ },
+ "insertionIndex": {
+ "description": "The index where the text will be inserted, in Unicode code units, based\non TextElement indexes.\n\nThe index is zero-based and is computed from the start of the string.\nThe index may be adjusted to prevent insertions inside Unicode grapheme\nclusters. In these cases, the text will be inserted immediately after the\ngrapheme cluster.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "cellLocation": {
+ "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table.",
+ "$ref": "TableCellLocation"
+ }
+ },
+ "id": "InsertTextRequest"
},
"AffineTransform": {
"description": "AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ]\nto transform source coordinates (x,y) into destination coordinates (x', y')\naccording to:\n\n x' x = shear_y scale_y translate_y \n 1 [ 1 ]\n\nAfter transformation,\n\n x' = scale_x * x + shear_x * y + translate_x;\n y' = scale_y * y + shear_y * x + translate_y;\n\nThis message is therefore composed of these six matrix elements.",
"type": "object",
"properties": {
+ "scaleX": {
+ "description": "The X coordinate scaling element.",
+ "format": "double",
+ "type": "number"
+ },
+ "shearX": {
+ "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",
@@ -2130,68 +2521,28 @@
"type": "number"
},
"unit": {
- "enumDescriptions": [
- "The units are unknown.",
- "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.",
- "A point, 1/72 of an inch."
- ],
"enum": [
"UNIT_UNSPECIFIED",
"EMU",
"PT"
],
"description": "The units for translate elements.",
- "type": "string"
- },
- "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"
+ "type": "string",
+ "enumDescriptions": [
+ "The units are unknown.",
+ "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.",
+ "A point, 1/72 of an inch."
+ ]
}
},
"id": "AffineTransform"
},
- "InsertTextRequest": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the shape or table where the text will be inserted.",
- "type": "string"
- },
- "text": {
- "description": "The text to be inserted.\n\nInserting a newline character will implicitly create a new\nParagraphMarker at that index.\nThe paragraph style of the new paragraph will be copied from the paragraph\nat the current insertion index, including lists and bullets.\n\nText styles for inserted text will be determined automatically, generally\npreserving the styling of neighboring text. In most cases, the text will be\nadded to the TextRun that exists at the\ninsertion index.\n\nSome control characters (U+0000-U+0008, U+000C-U+001F) and characters\nfrom the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF)\nwill be stripped out of the inserted text.",
- "type": "string"
- },
- "insertionIndex": {
- "type": "integer",
- "description": "The index where the text will be inserted, in Unicode code units, based\non TextElement indexes.\n\nThe index is zero-based and is computed from the start of the string.\nThe index may be adjusted to prevent insertions inside Unicode grapheme\nclusters. In these cases, the text will be inserted immediately after the\ngrapheme cluster.",
- "format": "int32"
- },
- "cellLocation": {
- "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table.",
- "$ref": "TableCellLocation"
- }
- },
- "id": "InsertTextRequest",
- "description": "Inserts text into a shape or a table cell."
- },
"AutoText": {
- "description": "A TextElement kind that represents auto text.",
"type": "object",
"properties": {
"style": {
- "$ref": "TextStyle",
- "description": "The styling applied to this auto text."
+ "description": "The styling applied to this auto text.",
+ "$ref": "TextStyle"
},
"type": {
"enum": [
@@ -2206,22 +2557,42 @@
]
},
"content": {
- "type": "string",
- "description": "The rendered content of this auto text, if available."
+ "description": "The rendered content of this auto text, if available.",
+ "type": "string"
}
},
- "id": "AutoText"
+ "id": "AutoText",
+ "description": "A TextElement kind that represents auto text."
},
"CreateVideoResponse": {
- "description": "The result of creating a video.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created video.",
+ "type": "string"
+ }
+ },
+ "id": "CreateVideoResponse",
+ "description": "The result of creating a video."
+ },
+ "DeleteTextRequest": {
+ "description": "Deletes text from a shape or a table cell.",
"type": "object",
"properties": {
"objectId": {
"type": "string",
- "description": "The object ID of the created video."
+ "description": "The object ID of the shape or table from which the text will be deleted."
+ },
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to delete, based on TextElement indexes.\n\nThere is always an implicit newline character at the end of a shape's or\ntable cell's text that cannot be deleted. `Range.Type.ALL` will use the\ncorrect bounds, but care must be taken when specifying explicit bounds for\nrange types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text\nis \"ABC\", followed by an implicit newline, then the maximum value is 2 for\n`text_range.start_index` and 3 for `text_range.end_index`.\n\nDeleting text that crosses a paragraph boundary may result in changes\nto paragraph styles and lists as the two paragraphs are merged.\n\nRanges that include only one code unit of a surrogate pair are expanded to\ninclude both code units."
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The optional table cell location if the text is to be deleted from a table\ncell. If present, the object_id must refer to a table."
}
},
- "id": "CreateVideoResponse"
+ "id": "DeleteTextRequest"
},
"UpdatePageElementTransformRequest": {
"description": "Updates the transform of a page element.",
@@ -2236,8 +2607,6 @@
"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.",
@@ -2247,30 +2616,13 @@
"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": {
- "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."
- },
- "objectId": {
- "description": "The object ID of the shape or table from which the text will be deleted.",
- "type": "string"
- },
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to delete, based on TextElement indexes.\n\nThere is always an implicit newline character at the end of a shape's or\ntable cell's text that cannot be deleted. `Range.Type.ALL` will use the\ncorrect bounds, but care must be taken when specifying explicit bounds for\nrange types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text\nis \"ABC\", followed by an implicit newline, then the maximum value is 2 for\n`text_range.start_index` and 3 for `text_range.end_index`.\n\nDeleting text that crosses a paragraph boundary may result in changes\nto paragraph styles and lists as the two paragraphs are merged.\n\nRanges that include only one code unit of a surrogate pair are expanded to\ninclude both code units."
- }
- },
- "id": "DeleteTextRequest"
- },
"DeleteObjectRequest": {
"description": "Deletes an object, either pages or\npage elements, from the\npresentation.",
"type": "object",
@@ -2283,7 +2635,6 @@
"id": "DeleteObjectRequest"
},
"TextElement": {
- "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell.",
"type": "object",
"properties": {
"startIndex": {
@@ -2297,21 +2648,24 @@
"type": "integer"
},
"textRun": {
- "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs.",
- "$ref": "TextRun"
+ "$ref": "TextRun",
+ "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs."
},
"autoText": {
- "$ref": "AutoText",
- "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time."
+ "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time.",
+ "$ref": "AutoText"
},
"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."
+ "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"
}
},
- "id": "TextElement"
+ "id": "TextElement",
+ "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell."
},
"Dimension": {
+ "description": "A magnitude in a single direction in the specified units.",
+ "type": "object",
"properties": {
"magnitude": {
"description": "The magnitude.",
@@ -2319,7 +2673,6 @@
"type": "number"
},
"unit": {
- "description": "The units for magnitude.",
"type": "string",
"enumDescriptions": [
"The units are unknown.",
@@ -2330,23 +2683,22 @@
"UNIT_UNSPECIFIED",
"EMU",
"PT"
- ]
+ ],
+ "description": "The units for magnitude."
}
},
- "id": "Dimension",
- "description": "A magnitude in a single direction in the specified units.",
- "type": "object"
+ "id": "Dimension"
},
"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",
- "description": "The fill of the line."
+ "id": "LineFill"
},
"VideoProperties": {
"description": "The properties of the Video.",
@@ -2360,13 +2712,15 @@
"id": "VideoProperties"
},
"InsertTableRowsRequest": {
- "id": "InsertTableRowsRequest",
- "description": "Inserts rows into a table.",
- "type": "object",
"properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of rows to be inserted. Maximum 20 per request.",
+ "format": "int32"
+ },
"cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell."
+ "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell.",
+ "$ref": "TableCellLocation"
},
"tableObjectId": {
"description": "The table to insert rows into.",
@@ -2375,21 +2729,19 @@
"insertBelow": {
"description": "Whether to insert new rows below the reference cell location.\n\n- `True`: insert below the cell.\n- `False`: insert above the cell.",
"type": "boolean"
- },
- "number": {
- "description": "The number of rows to be inserted. Maximum 20 per request.",
- "format": "int32",
- "type": "integer"
}
- }
+ },
+ "id": "InsertTableRowsRequest",
+ "description": "Inserts rows into a table.",
+ "type": "object"
},
"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"
+ "type": "string",
+ "description": "The object ID of the master that this layout is based on."
},
"name": {
"description": "The name of the layout.",
@@ -2402,63 +2754,17 @@
},
"id": "LayoutProperties"
},
- "Presentation": {
+ "LineProperties": {
+ "description": "The properties of the Line.\n\nWhen unset, these fields default to values that match the appearance of\nnew lines created in the Slides editor.",
"type": "object",
"properties": {
- "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."
+ "weight": {
+ "description": "The thickness of the line.",
+ "$ref": "Dimension"
},
- "title": {
- "description": "The title of the presentation.",
- "type": "string"
- },
- "layouts": {
- "type": "array",
- "items": {
- "$ref": "Page"
- },
- "description": "The layouts in the presentation. A layout is a template that determines\nhow content is arranged and styled on the slides that inherit from that\nlayout."
- },
- "masters": {
- "description": "The slide masters in the presentation. A slide master contains all common\npage elements and the common properties for a set of layouts. They serve\nthree purposes:\n\n- Placeholder shapes on a master contain the default text styles and shape\n properties of all placeholder shapes on pages that use that master.\n- The master page properties define the common page properties inherited by\n its layouts.\n- Any other shapes on the master slide will appear on all slides using that\n master, regardless of their layout.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- },
- "locale": {
- "description": "The locale of the presentation, as an IETF BCP 47 language tag.",
- "type": "string"
- },
- "pageSize": {
- "$ref": "Size",
- "description": "The size of pages in the presentation."
- },
- "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": {
- "description": "The revision ID of the presentation. Can be used in update requests\nto assert that the presentation revision hasn't changed since the last\nread operation. Only populated if the user has edit access to the\npresentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.",
- "type": "string"
- }
- },
- "id": "Presentation",
- "description": "A Google Slides presentation."
- },
- "LineProperties": {
- "properties": {
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the line. If unset, there is no link."
+ "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": {
"description": "The dash style of the line.",
@@ -2482,7 +2788,54 @@
"LONG_DASH_DOT"
]
},
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the line. If unset, there is no link."
+ },
+ "startArrow": {
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified arrow style.",
+ "No arrow.",
+ "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.",
+ "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.",
+ "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.",
+ "Filled square.",
+ "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.",
+ "Hollow arrow.",
+ "Hollow circle.",
+ "Hollow square.",
+ "Hollow diamond."
+ ],
+ "enum": [
+ "ARROW_STYLE_UNSPECIFIED",
+ "NONE",
+ "STEALTH_ARROW",
+ "FILL_ARROW",
+ "FILL_CIRCLE",
+ "FILL_SQUARE",
+ "FILL_DIAMOND",
+ "OPEN_ARROW",
+ "OPEN_CIRCLE",
+ "OPEN_SQUARE",
+ "OPEN_DIAMOND"
+ ],
+ "description": "The style of the arrow at the beginning of the line."
+ },
"endArrow": {
+ "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": [
@@ -2497,69 +2850,74 @@
"Hollow circle.",
"Hollow square.",
"Hollow diamond."
- ],
- "enum": [
- "ARROW_STYLE_UNSPECIFIED",
- "NONE",
- "STEALTH_ARROW",
- "FILL_ARROW",
- "FILL_CIRCLE",
- "FILL_SQUARE",
- "FILL_DIAMOND",
- "OPEN_ARROW",
- "OPEN_CIRCLE",
- "OPEN_SQUARE",
- "OPEN_DIAMOND"
]
- },
- "startArrow": {
- "description": "The style of the arrow at the beginning of the line.",
- "type": "string",
- "enumDescriptions": [
- "An unspecified arrow style.",
- "No arrow.",
- "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.",
- "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.",
- "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.",
- "Filled square.",
- "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.",
- "Hollow arrow.",
- "Hollow circle.",
- "Hollow square.",
- "Hollow diamond."
- ],
- "enum": [
- "ARROW_STYLE_UNSPECIFIED",
- "NONE",
- "STEALTH_ARROW",
- "FILL_ARROW",
- "FILL_CIRCLE",
- "FILL_SQUARE",
- "FILL_DIAMOND",
- "OPEN_ARROW",
- "OPEN_CIRCLE",
- "OPEN_SQUARE",
- "OPEN_DIAMOND"
- ]
- },
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the line."
- },
- "lineFill": {
- "$ref": "LineFill",
- "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor."
}
},
- "id": "LineProperties",
- "description": "The properties of the Line.\n\nWhen unset, these fields default to values that match the appearance of\nnew lines created in the Slides editor.",
- "type": "object"
+ "id": "LineProperties"
+ },
+ "Presentation": {
+ "id": "Presentation",
+ "description": "A Google Slides presentation.",
+ "type": "object",
+ "properties": {
+ "presentationId": {
+ "description": "The ID of the presentation.",
+ "type": "string"
+ },
+ "slides": {
+ "description": "The slides in the presentation.\nA slide inherits properties from a slide layout.",
+ "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. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.",
+ "type": "string"
+ },
+ "notesMaster": {
+ "$ref": "Page",
+ "description": "The notes master in the presentation. It serves three purposes:\n\n- Placeholder shapes on a notes master contain the default text styles and\n shape properties of all placeholder shapes on notes pages. Specifically,\n a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a\n `BODY` placeholder shape contains the speaker notes.\n- The notes master page properties define the common page properties\n inherited by all notes pages.\n- Any other shapes on the notes master will appear on all notes pages.\n\nThe notes master is read-only."
+ },
+ "title": {
+ "description": "The title of the presentation.",
+ "type": "string"
+ },
+ "layouts": {
+ "description": "The layouts in the presentation. A layout is a template that determines\nhow content is arranged and styled on the slides that inherit from that\nlayout.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "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",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "pageSize": {
+ "description": "The size of pages in the presentation.",
+ "$ref": "Size"
+ }
+ }
},
"OpaqueColor": {
"description": "A themeable solid color value.",
"type": "object",
"properties": {
+ "rgbColor": {
+ "description": "An opaque RGB color.",
+ "$ref": "RgbColor"
+ },
"themeColor": {
+ "description": "An opaque theme color.",
+ "type": "string",
"enumDescriptions": [
"Unspecified theme color. This value should not be used.",
"Represents the first dark color.",
@@ -2597,19 +2955,24 @@
"BACKGROUND1",
"TEXT2",
"BACKGROUND2"
- ],
- "description": "An opaque theme color.",
- "type": "string"
- },
- "rgbColor": {
- "description": "An opaque RGB color.",
- "$ref": "RgbColor"
+ ]
}
},
"id": "OpaqueColor"
},
"ImageProperties": {
+ "description": "The properties of the Image.",
+ "type": "object",
"properties": {
+ "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"
+ },
"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",
@@ -2619,36 +2982,25 @@
"$ref": "Shadow",
"description": "The shadow of the image. If not set, the image has no shadow. This property\nis read-only."
},
- "contrast": {
- "type": "number",
- "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"
- },
"link": {
- "description": "The hyperlink destination of the image. If unset, there is no link.",
- "$ref": "Link"
+ "$ref": "Link",
+ "description": "The hyperlink destination of the image. If unset, there is no link."
},
- "recolor": {
- "$ref": "Recolor",
- "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only."
- },
- "cropProperties": {
- "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only.",
- "$ref": "CropProperties"
- },
- "outline": {
- "$ref": "Outline",
- "description": "The outline of the image. If not set, the 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.",
+ "contrast": {
+ "description": "The contrast effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
"format": "float",
"type": "number"
+ },
+ "recolor": {
+ "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only.",
+ "$ref": "Recolor"
+ },
+ "cropProperties": {
+ "$ref": "CropProperties",
+ "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only."
}
},
- "id": "ImageProperties",
- "description": "The properties of the Image.",
- "type": "object"
+ "id": "ImageProperties"
},
"ReplaceAllShapesWithImageResponse": {
"description": "The result of replacing shapes with an image.",
@@ -2663,8 +3015,16 @@
"id": "ReplaceAllShapesWithImageResponse"
},
"Line": {
+ "id": "Line",
+ "description": "A PageElement kind representing a\nline, curved connector, or bent connector.",
+ "type": "object",
"properties": {
+ "lineProperties": {
+ "description": "The properties of the line.",
+ "$ref": "LineProperties"
+ },
"lineType": {
+ "description": "The type of the line.",
"type": "string",
"enumDescriptions": [
"An unspecified line type.",
@@ -2689,17 +3049,45 @@
"CURVED_CONNECTOR_3",
"CURVED_CONNECTOR_4",
"CURVED_CONNECTOR_5"
- ],
- "description": "The type of the line."
+ ]
+ }
+ }
+ },
+ "CreateSheetsChartRequest": {
+ "description": "Creates an embedded Google Sheets chart.\n\nNOTE: Chart creation requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf specified, the ID must be unique among all pages and page elements in\nthe presentation. The ID should start with a word character [a-zA-Z0-9_]\nand then followed by any number of the following characters [a-zA-Z0-9_-:].\nThe length of the ID should not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.",
+ "type": "string"
},
- "lineProperties": {
- "description": "The properties of the line.",
- "$ref": "LineProperties"
+ "elementProperties": {
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the chart.\n\nWhen the aspect ratio of the provided size does not match the chart aspect\nratio, the chart is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
+ },
+ "spreadsheetId": {
+ "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
+ "type": "string"
+ },
+ "linkingMode": {
+ "enum": [
+ "NOT_LINKED_IMAGE",
+ "LINKED"
+ ],
+ "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked.",
+ "type": "string",
+ "enumDescriptions": [
+ "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
+ "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
+ ]
+ },
+ "chartId": {
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "Line",
- "description": "A PageElement kind representing a\nline, curved connector, or bent connector.",
- "type": "object"
+ "id": "CreateSheetsChartRequest"
},
"BatchUpdatePresentationResponse": {
"description": "Response message from a batch update.",
@@ -2719,57 +3107,25 @@
},
"id": "BatchUpdatePresentationResponse"
},
- "CreateSheetsChartRequest": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf specified, the ID must be unique among all pages and page elements in\nthe presentation. The ID should start with a word character [a-zA-Z0-9_]\nand then followed by any number of the following characters [a-zA-Z0-9_-:].\nThe length of the ID should not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.",
- "type": "string"
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the chart.\n\nWhen the aspect ratio of the provided size does not match the chart aspect\nratio, the chart is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
- },
- "spreadsheetId": {
- "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
- "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.",
- "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
- ],
- "enum": [
- "NOT_LINKED_IMAGE",
- "LINKED"
- ]
- },
- "chartId": {
- "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "CreateSheetsChartRequest",
- "description": "Creates an embedded Google Sheets chart.\n\nNOTE: Chart creation requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes."
- },
"CreateImageResponse": {
- "description": "The result of creating an image.",
"type": "object",
"properties": {
"objectId": {
- "type": "string",
- "description": "The object ID of the created image."
+ "description": "The object ID of the created image.",
+ "type": "string"
}
},
- "id": "CreateImageResponse"
+ "id": "CreateImageResponse",
+ "description": "The result of creating an image."
},
"SlideProperties": {
"description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
"type": "object",
"properties": {
+ "notesPage": {
+ "$ref": "Page",
+ "description": "The notes page that this slide is associated with. It defines the visual\nappearance of a notes page when printing or exporting slides with speaker\nnotes. A notes page inherits properties from the\nnotes master.\nThe placeholder shape with type BODY on the notes page contains the speaker\nnotes for this slide. The ID of this shape is identified by the\nspeakerNotesObjectId field.\nThe notes page is read-only except for the text content and styles of the\nspeaker notes shape."
+ },
"layoutObjectId": {
"description": "The object ID of the layout that this slide is based on.",
"type": "string"
@@ -2777,89 +3133,83 @@
"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"
},
"Response": {
+ "description": "A single response from an update.",
"type": "object",
"properties": {
- "createVideo": {
- "description": "The result of creating a video.",
- "$ref": "CreateVideoResponse"
- },
- "replaceAllShapesWithSheetsChart": {
- "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart.",
- "$ref": "ReplaceAllShapesWithSheetsChartResponse"
- },
- "createSheetsChart": {
- "$ref": "CreateSheetsChartResponse",
- "description": "The result of creating a Google Sheets chart."
- },
- "replaceAllShapesWithImage": {
- "$ref": "ReplaceAllShapesWithImageResponse",
- "description": "The result of replacing all shapes matching some criteria with an\nimage."
- },
- "createTable": {
- "$ref": "CreateTableResponse",
- "description": "The result of creating a table."
- },
- "replaceAllText": {
- "$ref": "ReplaceAllTextResponse",
- "description": "The result of replacing text."
- },
- "createSlide": {
- "$ref": "CreateSlideResponse",
- "description": "The result of creating a slide."
- },
"createShape": {
"$ref": "CreateShapeResponse",
"description": "The result of creating a shape."
},
"duplicateObject": {
- "$ref": "DuplicateObjectResponse",
- "description": "The result of duplicating an object."
+ "description": "The result of duplicating an object.",
+ "$ref": "DuplicateObjectResponse"
},
"createLine": {
"$ref": "CreateLineResponse",
"description": "The result of creating a line."
},
"createImage": {
- "$ref": "CreateImageResponse",
- "description": "The result of creating an image."
- }
- },
- "id": "Response",
- "description": "A single response from an update."
- },
- "TextRun": {
- "type": "object",
- "properties": {
- "content": {
- "description": "The text of this run.",
- "type": "string"
+ "description": "The result of creating an image.",
+ "$ref": "CreateImageResponse"
},
- "style": {
- "$ref": "TextStyle",
- "description": "The styling applied to this run."
+ "createVideo": {
+ "$ref": "CreateVideoResponse",
+ "description": "The result of creating a video."
+ },
+ "createSheetsChart": {
+ "description": "The result of creating a Google Sheets chart.",
+ "$ref": "CreateSheetsChartResponse"
+ },
+ "replaceAllShapesWithSheetsChart": {
+ "$ref": "ReplaceAllShapesWithSheetsChartResponse",
+ "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart."
+ },
+ "replaceAllShapesWithImage": {
+ "$ref": "ReplaceAllShapesWithImageResponse",
+ "description": "The result of replacing all shapes matching some criteria with an\nimage."
+ },
+ "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."
}
},
- "id": "TextRun",
- "description": "A TextElement kind that represents a run of text that all has the same\nstyling."
+ "id": "Response"
+ },
+ "SubstringMatchCriteria": {
+ "properties": {
+ "matchCase": {
+ "description": "Indicates whether the search should respect case:\n\n- `True`: the search is case sensitive.\n- `False`: the search is case insensitive.",
+ "type": "boolean"
+ },
+ "text": {
+ "type": "string",
+ "description": "The text to search for in the shape or table."
+ }
+ },
+ "id": "SubstringMatchCriteria",
+ "description": "A criteria that matches a specific string of text in a shape or table.",
+ "type": "object"
},
"LayoutReference": {
"description": "Slide layout reference. This may reference either:\n\n- A predefined layout\n- One of the layouts in the presentation.",
"type": "object",
"properties": {
- "layoutId": {
- "description": "Layout ID: the object ID of one of the layouts in the presentation.",
- "type": "string"
- },
"predefinedLayout": {
+ "description": "Predefined layout.",
+ "type": "string",
"enumDescriptions": [
"Unspecified layout.",
"Blank layout, with no placeholders.",
@@ -2887,34 +3237,37 @@
"ONE_COLUMN_TEXT",
"MAIN_POINT",
"BIG_NUMBER"
- ],
- "description": "Predefined layout.",
+ ]
+ },
+ "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.",
+ "TextRun": {
+ "description": "A TextElement kind that represents a run of text that all has the same\nstyling.",
"type": "object",
"properties": {
- "text": {
- "description": "The text to search for in the shape or table.",
+ "content": {
+ "description": "The text of this run.",
"type": "string"
},
- "matchCase": {
- "type": "boolean",
- "description": "Indicates whether the search should respect case:\n\n- `True`: the search is case sensitive.\n- `False`: the search is case insensitive."
+ "style": {
+ "$ref": "TextStyle",
+ "description": "The styling applied to this run."
}
},
- "id": "SubstringMatchCriteria"
+ "id": "TextRun"
},
"TableRange": {
+ "description": "A table range represents a reference to a subset of a table.\n\nIt's important to note that the cells specified by a table range do not\nnecessarily form a rectangle. For example, let's say we have a 3 x 3 table\nwhere all the cells of the last row are merged together. The table looks\nlike this:\n\n \n [ ]\n\nA table range with location = (0, 0), row span = 3 and column span = 2\nspecifies the following cells:\n\n x x \n [ x ]",
"type": "object",
"properties": {
"location": {
- "description": "The starting location of the table range.",
- "$ref": "TableCellLocation"
+ "$ref": "TableCellLocation",
+ "description": "The starting location of the table range."
},
"rowSpan": {
"description": "The row span of the table range.",
@@ -2922,37 +3275,31 @@
"type": "integer"
},
"columnSpan": {
- "type": "integer",
"description": "The column span of the table range.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
},
- "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 ]"
+ "id": "TableRange"
},
"CreateTableResponse": {
- "id": "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"
},
"CreateTableRequest": {
"description": "Creates a new table.",
"type": "object",
"properties": {
- "rows": {
- "description": "Number of rows in the table.",
- "format": "int32",
- "type": "integer"
- },
"objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
+ "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.",
@@ -2962,25 +3309,24 @@
"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"
}
},
"id": "CreateTableRequest"
},
"Table": {
- "description": "A PageElement kind representing a\ntable.",
"type": "object",
"properties": {
- "rows": {
- "description": "Number of rows in the table.",
- "format": "int32",
- "type": "integer"
- },
"tableColumns": {
+ "description": "Properties of each column.",
"type": "array",
"items": {
"$ref": "TableColumnProperties"
- },
- "description": "Properties of each column."
+ }
},
"columns": {
"description": "Number of columns in the table.",
@@ -2993,22 +3339,18 @@
"items": {
"$ref": "TableRow"
}
+ },
+ "rows": {
+ "description": "Number of rows in the table.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "Table"
+ "id": "Table",
+ "description": "A PageElement kind representing a\ntable."
},
"PageBackgroundFill": {
- "description": "The page background fill.",
- "type": "object",
"properties": {
- "stretchedPictureFill": {
- "description": "Stretched picture fill.",
- "$ref": "StretchedPictureFill"
- },
- "solidFill": {
- "description": "Solid color fill.",
- "$ref": "SolidFill"
- },
"propertyState": {
"enumDescriptions": [
"If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
@@ -3022,9 +3364,19 @@
],
"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",
+ "description": "Stretched picture fill."
+ },
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
}
},
- "id": "PageBackgroundFill"
+ "id": "PageBackgroundFill",
+ "description": "The page background fill.",
+ "type": "object"
},
"SheetsChart": {
"description": "A PageElement kind representing\na linked chart embedded from Google Sheets.",
@@ -3051,6 +3403,8 @@
"id": "SheetsChart"
},
"SolidFill": {
+ "description": "A solid color fill. The page or page element is filled entirely with the\nspecified color value.\n\nIf any field is unset, its value may be inherited from a parent placeholder\nif it exists.",
+ "type": "object",
"properties": {
"alpha": {
"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.",
@@ -3058,13 +3412,11 @@
"type": "number"
},
"color": {
- "$ref": "OpaqueColor",
- "description": "The color value of the solid fill."
+ "description": "The color value of the solid fill.",
+ "$ref": "OpaqueColor"
}
},
- "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.",
- "type": "object"
+ "id": "SolidFill"
},
"ThemeColorPair": {
"description": "A pair mapping a theme color type to the concrete color it represents.",
@@ -3075,7 +3427,6 @@
"description": "The concrete color corresponding to the theme color type above."
},
"type": {
- "type": "string",
"enumDescriptions": [
"Unspecified theme color. This value should not be used.",
"Represents the first dark color.",
@@ -3114,37 +3465,38 @@
"TEXT2",
"BACKGROUND2"
],
- "description": "The type of the theme color."
+ "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": {
- "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color.",
- "$ref": "OpaqueColor"
+ "$ref": "OpaqueColor",
+ "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color."
}
},
- "id": "OptionalColor",
- "description": "A color that can either be fully opaque or fully transparent."
+ "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": {
"size": {
- "description": "The size of the element.",
- "$ref": "Size"
+ "$ref": "Size",
+ "description": "The size of the element."
},
"transform": {
"$ref": "AffineTransform",
"description": "The transform for the element."
},
"pageObjectId": {
- "type": "string",
- "description": "The object ID of the page where the element is located."
+ "description": "The object ID of the page where the element is located.",
+ "type": "string"
}
},
"id": "PageElementProperties"
@@ -3161,42 +3513,42 @@
"id": "SheetsChartProperties"
},
"StretchedPictureFill": {
+ "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.",
"type": "object",
"properties": {
+ "size": {
+ "$ref": "Size",
+ "description": "The original size of the picture fill. This field is read-only."
+ },
"contentUrl": {
"description": "Reading the content_url:\n\nAn URL to a picture with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the picture as the original requester. Access to the\npicture may be lost if the presentation's sharing settings change.\n\nWriting the content_url:\n\nThe picture is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Pictures must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.",
"type": "string"
- },
- "size": {
- "description": "The original size of the picture fill. This field is read-only.",
- "$ref": "Size"
}
- },
- "id": "StretchedPictureFill"
+ }
},
"DeleteTableColumnRequest": {
+ "description": "Deletes a column from a table.",
+ "type": "object",
"properties": {
"tableObjectId": {
- "type": "string",
- "description": "The table to delete columns from."
+ "description": "The table to delete columns from.",
+ "type": "string"
},
"cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted."
+ "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted.",
+ "$ref": "TableCellLocation"
}
},
- "id": "DeleteTableColumnRequest",
- "description": "Deletes a column from a table.",
- "type": "object"
+ "id": "DeleteTableColumnRequest"
},
"UpdateTextStyleRequest": {
"description": "Update the styling of text in a Shape or\nTable.",
"type": "object",
"properties": {
"objectId": {
- "type": "string",
- "description": "The object ID of the shape or table with the text to be styled."
+ "description": "The object ID of the shape or table with the text to be styled.",
+ "type": "string"
},
"textRange": {
"description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style.",
@@ -3207,8 +3559,8 @@
"description": "The location of the cell in the table containing the text to style. If\n`object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
},
"style": {
- "$ref": "TextStyle",
- "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information."
+ "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.",
@@ -3219,22 +3571,22 @@
"id": "UpdateTextStyleRequest"
},
"List": {
+ "id": "List",
"description": "A List describes the look and feel of bullets belonging to paragraphs\nassociated with a list. A paragraph that is part of a list has an implicit\nreference to that list's ID.",
"type": "object",
"properties": {
- "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"
+ },
+ "listId": {
+ "type": "string",
+ "description": "The ID of the list."
}
- },
- "id": "List"
+ }
},
"WeightedFontFamily": {
"description": "Represents a font family and weight used to style a TextRun.",
@@ -3251,609 +3603,13 @@
}
},
"id": "WeightedFontFamily"
- },
- "PageElement": {
- "id": "PageElement",
- "description": "A visual element rendered on a page.",
- "type": "object",
- "properties": {
- "size": {
- "description": "The size of the page element.",
- "$ref": "Size"
- },
- "sheetsChart": {
- "$ref": "SheetsChart",
- "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images."
- },
- "title": {
- "description": "The title of the page element. Combined with description to display alt\ntext.",
- "type": "string"
- },
- "video": {
- "description": "A video page element.",
- "$ref": "Video"
- },
- "wordArt": {
- "$ref": "WordArt",
- "description": "A word art page element."
- },
- "table": {
- "$ref": "Table",
- "description": "A table page element."
- },
- "objectId": {
- "description": "The object ID for this page element. Object IDs used by\ngoogle.apps.slides.v1.Page and\ngoogle.apps.slides.v1.PageElement share the same namespace.",
- "type": "string"
- },
- "transform": {
- "$ref": "AffineTransform",
- "description": "The transform of the page element."
- },
- "shape": {
- "description": "A generic shape.",
- "$ref": "Shape"
- },
- "line": {
- "description": "A line page element.",
- "$ref": "Line"
- },
- "description": {
- "description": "The description of the page element. Combined with title to display alt\ntext.",
- "type": "string"
- },
- "elementGroup": {
- "$ref": "Group",
- "description": "A collection of page elements joined as a single unit."
- },
- "image": {
- "description": "An image page element.",
- "$ref": "Image"
- }
- }
- },
- "CreateImageRequest": {
- "description": "Creates an image.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the image.\n\nWhen the aspect ratio of the provided size does not match the image aspect\nratio, the image is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
- },
- "url": {
- "type": "string",
- "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat."
- }
- },
- "id": "CreateImageRequest"
- },
- "CreateParagraphBulletsRequest": {
- "description": "Creates bullets for all of the paragraphs that overlap with the given\ntext index range.\n\nThe nesting level of each paragraph will be determined by counting leading\ntabs in front of each paragraph. To avoid excess space between the bullet and\nthe corresponding paragraph, these leading tabs are removed by this request.\nThis may change the indices of parts of the text.\n\nIf the paragraph immediately before paragraphs being updated is in a list\nwith a matching preset, the paragraphs being updated are added to that\npreceding list.",
- "type": "object",
- "properties": {
- "bulletPreset": {
- "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."
- ]
- },
- "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": {
- "description": "The range of text to apply the bullet presets to, based on TextElement indexes.",
- "$ref": "Range"
- }
- },
- "id": "CreateParagraphBulletsRequest"
- },
- "TextStyle": {
- "type": "object",
- "properties": {
- "italic": {
- "description": "Whether or not the text is italicized.",
- "type": "boolean"
- },
- "strikethrough": {
- "description": "Whether or not the text is struck through.",
- "type": "boolean"
- },
- "fontSize": {
- "$ref": "Dimension",
- "description": "The size of the text's font. When read, the `font_size` will specified in\npoints."
- },
- "baselineOffset": {
- "enum": [
- "BASELINE_OFFSET_UNSPECIFIED",
- "NONE",
- "SUPERSCRIPT",
- "SUBSCRIPT"
- ],
- "description": "The text's vertical offset from its normal position.\n\nText with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically\nrendered in a smaller font size, computed based on the `font_size` field.\nThe `font_size` itself is not affected by changes in this field.",
- "type": "string",
- "enumDescriptions": [
- "The text's baseline offset is inherited from the parent.",
- "The text is not vertically offset.",
- "The text is vertically offset upwards (superscript).",
- "The text is vertically offset downwards (subscript)."
- ]
- },
- "weightedFontFamily": {
- "$ref": "WeightedFontFamily",
- "description": "The font family and rendered weight of the text.\n\nThis field is an extension of `font_family` meant to support explicit font\nweights without breaking backwards compatibility. As such, when reading the\nstyle of a range of text, the value of `weighted_font_family#font_family`\nwill always be equal to that of `font_family`. However, when writing, if\nboth fields are included in the field mask (either explicitly or through\nthe wildcard `\"*\"`), their values are reconciled as follows:\n\n* If `font_family` is set and `weighted_font_family` is not, the value of\n `font_family` is applied with weight `400` (\"normal\").\n* If both fields are set, the value of `font_family` must match that of\n `weighted_font_family#font_family`. If so, the font family and weight of\n `weighted_font_family` is applied. Otherwise, a 400 bad request error is\n returned.\n* If `weighted_font_family` is set and `font_family` is not, the font\n family and weight of `weighted_font_family` is applied.\n* If neither field is set, the font family and weight of the text inherit\n from the parent. Note that these properties cannot inherit separately\n from each other.\n\nIf an update request specifies values for both `weighted_font_family` and\n`bold`, the `weighted_font_family` is applied first, then `bold`.\n\nIf `weighted_font_family#weight` is not set, it defaults to `400`.\n\nIf `weighted_font_family` is set, then `weighted_font_family#font_family`\nmust also be set with a non-empty value. Otherwise, a 400 bad request error\nis returned."
- },
- "smallCaps": {
- "description": "Whether or not the text is in small capital letters.",
- "type": "boolean"
- },
- "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"
- },
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the text. If unset, there is no link. Links\nare not inherited from parent text.\n\nChanging the link in an update request causes some other changes to the\ntext style of the range:\n\n* When setting a link, the text foreground color will be set to\n ThemeColorType.HYPERLINK and the text will\n be underlined. If these fields are modified in the same\n request, those values will be used instead of the link defaults.\n* Setting a link on a text range that overlaps with an existing link will\n also update the existing link to point to the new URL.\n* Links are not settable on newline characters. As a result, setting a link\n on a text range that crosses a paragraph boundary, such as `\"ABC\\n123\"`,\n will separate the newline character(s) into their own text runs. The\n link will be applied separately to the runs before and after the newline.\n* Removing a link will update the text style of the range to match the\n style of the preceding text (or the default text styles if the preceding\n text is another link) unless different styles are being set in the same\n request."
- },
- "underline": {
- "description": "Whether or not the text is underlined.",
- "type": "boolean"
- },
- "foregroundColor": {
- "$ref": "OptionalColor",
- "description": "The color of the text itself. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set."
- },
- "bold": {
- "description": "Whether or not the text is rendered as bold.",
- "type": "boolean"
- },
- "fontFamily": {
- "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.\n\nSome fonts can affect the weight of the text. If an update request\nspecifies values for both `font_family` and `bold`, the explicitly-set\n`bold` value is used.",
- "type": "string"
- }
- },
- "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."
- },
- "Size": {
- "type": "object",
- "properties": {
- "height": {
- "description": "The height of the object.",
- "$ref": "Dimension"
- },
- "width": {
- "description": "The width of the object.",
- "$ref": "Dimension"
- }
- },
- "id": "Size",
- "description": "A width and height."
- },
- "UpdateVideoPropertiesRequest": {
- "properties": {
- "objectId": {
- "description": "The object ID of the video the updates are applied to.",
- "type": "string"
- },
- "videoProperties": {
- "description": "The video properties to update.",
- "$ref": "VideoProperties"
- },
- "fields": {
- "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",
- "description": "Update the properties of a Video.",
- "type": "object"
- },
- "Request": {
- "description": "A single kind of update to apply to a presentation.",
- "type": "object",
- "properties": {
- "createVideo": {
- "description": "Creates a video.",
- "$ref": "CreateVideoRequest"
- },
- "createSheetsChart": {
- "description": "Creates an embedded Google Sheets chart.",
- "$ref": "CreateSheetsChartRequest"
- },
- "replaceAllShapesWithSheetsChart": {
- "description": "Replaces all shapes matching some criteria with a Google Sheets chart.",
- "$ref": "ReplaceAllShapesWithSheetsChartRequest"
- },
- "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"
- },
- "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": {
- "description": "Inserts rows into a table.",
- "$ref": "InsertTableRowsRequest"
- },
- "createSlide": {
- "$ref": "CreateSlideRequest",
- "description": "Creates a new slide."
- },
- "updateLineProperties": {
- "$ref": "UpdateLinePropertiesRequest",
- "description": "Updates the properties of a Line."
- },
- "updateSlidesPosition": {
- "$ref": "UpdateSlidesPositionRequest",
- "description": "Updates the position of a set of slides in the presentation."
- },
- "deleteTableRow": {
- "$ref": "DeleteTableRowRequest",
- "description": "Deletes a row from a table."
- },
- "updateShapeProperties": {
- "$ref": "UpdateShapePropertiesRequest",
- "description": "Updates the properties of a Shape."
- },
- "insertText": {
- "$ref": "InsertTextRequest",
- "description": "Inserts text into a shape or table cell."
- },
- "deleteText": {
- "description": "Deletes text from a shape or a table cell.",
- "$ref": "DeleteTextRequest"
- },
- "updatePageProperties": {
- "$ref": "UpdatePagePropertiesRequest",
- "description": "Updates the properties of a Page."
- },
- "createShape": {
- "description": "Creates a new shape.",
- "$ref": "CreateShapeRequest"
- },
- "deleteParagraphBullets": {
- "description": "Deletes bullets from paragraphs.",
- "$ref": "DeleteParagraphBulletsRequest"
- },
- "insertTableColumns": {
- "$ref": "InsertTableColumnsRequest",
- "description": "Inserts columns into a table."
- },
- "refreshSheetsChart": {
- "$ref": "RefreshSheetsChartRequest",
- "description": "Refreshes a Google Sheets chart."
- },
- "updateTableCellProperties": {
- "description": "Updates the properties of a TableCell.",
- "$ref": "UpdateTableCellPropertiesRequest"
- },
- "createTable": {
- "$ref": "CreateTableRequest",
- "description": "Creates a new table."
- },
- "deleteObject": {
- "description": "Deletes a page or page element from the presentation.",
- "$ref": "DeleteObjectRequest"
- },
- "updateParagraphStyle": {
- "description": "Updates the styling of paragraphs within a Shape or Table.",
- "$ref": "UpdateParagraphStyleRequest"
- },
- "duplicateObject": {
- "$ref": "DuplicateObjectRequest",
- "description": "Duplicates a slide or page element."
- },
- "deleteTableColumn": {
- "$ref": "DeleteTableColumnRequest",
- "description": "Deletes a column from a table."
- },
- "updateVideoProperties": {
- "description": "Updates the properties of a Video.",
- "$ref": "UpdateVideoPropertiesRequest"
- },
- "createLine": {
- "$ref": "CreateLineRequest",
- "description": "Creates a line."
- },
- "createImage": {
- "$ref": "CreateImageRequest",
- "description": "Creates an image."
- },
- "createParagraphBullets": {
- "$ref": "CreateParagraphBulletsRequest",
- "description": "Creates bullets for paragraphs."
- }
- },
- "id": "Request"
- },
- "UpdateImagePropertiesRequest": {
- "description": "Update the properties of an Image.",
- "type": "object",
- "properties": {
- "imageProperties": {
- "$ref": "ImageProperties",
- "description": "The image properties to update."
- },
- "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": {
- "enum": [
- "TEXT_DIRECTION_UNSPECIFIED",
- "LEFT_TO_RIGHT",
- "RIGHT_TO_LEFT"
- ],
- "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT since\ntext direction is not inherited.",
- "type": "string",
- "enumDescriptions": [
- "The text direction is inherited from the parent.",
- "The text goes from left to right.",
- "The text goes from right to left."
- ]
- },
- "spacingMode": {
- "enumDescriptions": [
- "The spacing mode is inherited from the parent.",
- "Paragraph spacing is always rendered.",
- "Paragraph spacing is skipped between list elements."
- ],
- "enum": [
- "SPACING_MODE_UNSPECIFIED",
- "NEVER_COLLAPSE",
- "COLLAPSE_LISTS"
- ],
- "description": "The spacing mode for the paragraph.",
- "type": "string"
- },
- "indentEnd": {
- "$ref": "Dimension",
- "description": "The amount indentation for the paragraph on the side that corresponds to\nthe end of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent."
- },
- "indentStart": {
- "description": "The amount indentation for the paragraph on the side that corresponds to\nthe start of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent.",
- "$ref": "Dimension"
- },
- "spaceAbove": {
- "$ref": "Dimension",
- "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
- },
- "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": {
- "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent.",
- "format": "float",
- "type": "number"
- },
- "indentFirstLine": {
- "$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": {
- "description": "The result of replacing shapes with a Google Sheets chart.",
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "description": "The number of shapes replaced with charts.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ReplaceAllShapesWithSheetsChartResponse"
- },
- "TableCellProperties": {
- "description": "The properties of the TableCell.",
- "type": "object",
- "properties": {
- "tableCellBackgroundFill": {
- "$ref": "TableCellBackgroundFill",
- "description": "The background fill of the table cell. The default fill matches the fill\nfor newly created table cells in the Slides editor."
- }
- },
- "id": "TableCellProperties"
- },
- "RefreshSheetsChartRequest": {
- "description": "Refreshes an embedded Google Sheets chart by replacing it with the latest\nversion of the chart from Google Sheets.\n\nNOTE: Refreshing charts requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the chart to refresh.",
- "type": "string"
- }
- },
- "id": "RefreshSheetsChartRequest"
- },
- "Outline": {
- "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
- "type": "object",
- "properties": {
- "outlineFill": {
- "$ref": "OutlineFill",
- "description": "The fill of the outline."
- },
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the outline."
- },
- "dashStyle": {
- "enumDescriptions": [
- "Unspecified dash style.",
- "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ],
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ],
- "description": "The dash style of the outline.",
- "type": "string"
- },
- "propertyState": {
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ],
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The outline property state.\n\nUpdating the the outline on a page element will implicitly update this\nfield to`RENDERED`, unless another value is specified in the same request.\nTo have no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored.",
- "type": "string"
- }
- },
- "id": "Outline"
- },
- "TableColumnProperties": {
- "type": "object",
- "properties": {
- "columnWidth": {
- "$ref": "Dimension",
- "description": "Width of a column."
- }
- },
- "id": "TableColumnProperties",
- "description": "Properties of each column in a table."
- },
- "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": {
- "$ref": "ShapeBackgroundFill",
- "description": "The background fill of the shape. If unset, the background fill is\ninherited from a parent placeholder if it exists. If the shape has no\nparent, then the default background fill depends on the shape type,\nmatching the defaults for new shapes created in the Slides editor."
- },
- "shadow": {
- "description": "The shadow properties of the shape. If unset, the shadow is inherited from\na parent placeholder if it exists. If the shape has no parent, then the\ndefault shadow matches the defaults for new shapes created in the Slides\neditor. This property is read-only.",
- "$ref": "Shadow"
- }
- },
- "id": "ShapeProperties"
- },
- "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"
}
},
- "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": "Slides",
"auth": {
"oauth2": {
@@ -3884,5 +3640,270 @@
"name": "slides",
"batchPath": "batch",
"title": "Google Slides API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "presentations": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest version of the specified presentation.",
+ "response": {
+ "$ref": "Presentation"
+ },
+ "parameterOrder": [
+ "presentationId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/presentations.readonly"
+ ],
+ "parameters": {
+ "presentationId": {
+ "location": "path",
+ "description": "The ID of the presentation to retrieve.",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$"
+ }
+ },
+ "flatPath": "v1/presentations/{presentationsId}",
+ "path": "v1/presentations/{+presentationId}",
+ "id": "slides.presentations.get"
+ },
+ "create": {
+ "response": {
+ "$ref": "Presentation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/presentations"
+ ],
+ "flatPath": "v1/presentations",
+ "path": "v1/presentations",
+ "id": "slides.presentations.create",
+ "request": {
+ "$ref": "Presentation"
+ },
+ "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation."
+ },
+ "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": {
+ "description": "The presentation to apply the updates to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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": {
+ "description": "Gets the latest version of the specified page in the presentation.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "presentationId",
+ "pageObjectId"
+ ],
+ "response": {
+ "$ref": "Page"
+ },
+ "parameters": {
+ "presentationId": {
+ "location": "path",
+ "description": "The ID of the presentation to retrieve.",
+ "required": true,
+ "type": "string"
+ },
+ "pageObjectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The object ID of the page to retrieve."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/presentations.readonly"
+ ],
+ "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}",
+ "id": "slides.presentations.pages.get",
+ "path": "v1/presentations/{presentationId}/pages/{pageObjectId}"
+ },
+ "getThumbnail": {
+ "response": {
+ "$ref": "Thumbnail"
+ },
+ "parameterOrder": [
+ "presentationId",
+ "pageObjectId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageObjectId": {
+ "description": "The object ID of the page whose thumbnail to retrieve.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "thumbnailProperties.mimeType": {
+ "location": "query",
+ "enum": [
+ "PNG"
+ ],
+ "description": "The optional mime type of the thumbnail image.\n\nIf you don't specify the mime type, the default mime type will be PNG.",
+ "type": "string"
+ },
+ "thumbnailProperties.thumbnailSize": {
+ "enum": [
+ "THUMBNAIL_SIZE_UNSPECIFIED",
+ "LARGE"
+ ],
+ "description": "The optional thumbnail image size.\n\nIf you don't specify the size, the server chooses a default size of the\nimage.",
+ "type": "string",
+ "location": "query"
+ },
+ "presentationId": {
+ "description": "The ID of the presentation to retrieve.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/presentations.readonly"
+ ],
+ "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
+ "path": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
+ "id": "slides.presentations.pages.getThumbnail",
+ "description": "Generates a thumbnail of the latest version of the specified page in the\npresentation and returns a URL to the thumbnail image."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response."
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://slides.googleapis.com/"
}
diff --git a/slides/v1/slides-gen.go b/slides/v1/slides-gen.go
index 73936f5..5d82700 100644
--- a/slides/v1/slides-gen.go
+++ b/slides/v1/slides-gen.go
@@ -3646,12 +3646,12 @@
type Range struct {
// EndIndex: The optional zero-based index of the end of the
// collection.
- // Required for `SPECIFIC_RANGE` delete mode.
+ // Required for `FIXED_RANGE` ranges.
EndIndex int64 `json:"endIndex,omitempty"`
// StartIndex: The optional zero-based index of the beginning of the
// collection.
- // Required for `SPECIFIC_RANGE` and `FROM_START_INDEX` ranges.
+ // Required for `FIXED_RANGE` and `FROM_START_INDEX` ranges.
StartIndex int64 `json:"startIndex,omitempty"`
// Type: The type of range.
@@ -3864,6 +3864,16 @@
// format.
ImageUrl string `json:"imageUrl,omitempty"`
+ // PageObjectIds: If non-empty, limits the matches to page elements only
+ // on the given pages.
+ //
+ // Returns a 400 bad request error if given the page object ID of
+ // a
+ // notes page or a
+ // notes master, or if a
+ // page with that object ID doesn't exist in the presentation.
+ PageObjectIds []string `json:"pageObjectIds,omitempty"`
+
// ReplaceMethod: The replace method.
//
// Possible values:
@@ -3967,6 +3977,16 @@
// see a link to the spreadsheet.
LinkingMode string `json:"linkingMode,omitempty"`
+ // PageObjectIds: If non-empty, limits the matches to page elements only
+ // on the given pages.
+ //
+ // Returns a 400 bad request error if given the page object ID of
+ // a
+ // notes page or a
+ // notes master, or if a
+ // page with that object ID doesn't exist in the presentation.
+ PageObjectIds []string `json:"pageObjectIds,omitempty"`
+
// SpreadsheetId: The ID of the Google Sheets spreadsheet that contains
// the chart.
SpreadsheetId string `json:"spreadsheetId,omitempty"`
@@ -4030,6 +4050,15 @@
// ContainsText: Finds text in a shape matching this substring.
ContainsText *SubstringMatchCriteria `json:"containsText,omitempty"`
+ // PageObjectIds: If non-empty, limits the matches to page elements only
+ // on the given pages.
+ //
+ // Returns a 400 bad request error if given the page object ID of
+ // a
+ // notes master,
+ // or if a page with that object ID doesn't exist in the presentation.
+ PageObjectIds []string `json:"pageObjectIds,omitempty"`
+
// ReplaceText: The text that will replace the matched text.
ReplaceText string `json:"replaceText,omitempty"`
diff --git a/sourcerepo/v1/sourcerepo-api.json b/sourcerepo/v1/sourcerepo-api.json
index 438f3bc..a8837ea 100644
--- a/sourcerepo/v1/sourcerepo-api.json
+++ b/sourcerepo/v1/sourcerepo-api.json
@@ -1,301 +1,90 @@
{
- "title": "Cloud Source Repositories API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "repos": {
- "methods": {
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
- "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/[^/]+/repos/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "sourcerepo.projects.repos.testIamPermissions"
- },
- "delete": {
- "description": "Deletes a repo.",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "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/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
- "path": "v1/{+name}",
- "id": "sourcerepo.projects.repos.delete"
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The project ID whose repos should be listed. Values are of the form\n`projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos",
- "path": "v1/{+name}/repos",
- "id": "sourcerepo.projects.repos.list",
- "description": "Returns all repos belonging to a project.",
- "response": {
- "$ref": "ListReposResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET"
- },
- "create": {
- "description": "Creates a repo in the given project with the given name..\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.",
- "request": {
- "$ref": "Repo"
- },
- "response": {
- "$ref": "Repo"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos",
- "path": "v1/{+parent}/repos",
- "id": "sourcerepo.projects.repos.create"
- },
- "setIamPolicy": {
- "path": "v1/{+resource}:setIamPolicy",
- "id": "sourcerepo.projects.repos.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:setIamPolicy"
- },
- "getIamPolicy": {
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "sourcerepo.projects.repos.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET"
- },
- "get": {
- "response": {
- "$ref": "Repo"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the requested repository. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
- "path": "v1/{+name}",
- "id": "sourcerepo.projects.repos.get",
- "description": "Returns information about a repo."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format."
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- }
- },
"version": "v1",
"baseUrl": "https://sourcerepo.googleapis.com/",
- "servicePath": "",
- "description": "Access source code repositories hosted by Google.",
"kind": "discovery#restDescription",
+ "description": "Access source code repositories hosted by Google.",
+ "servicePath": "",
"basePath": "",
- "revision": "20170410",
- "documentationLink": "https://cloud.google.com/eap/cloud-repositories/cloud-sourcerepo-api",
+ "revision": "20170528",
"id": "sourcerepo:v1",
+ "documentationLink": "https://cloud.google.com/source-repositories/docs/apis",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Policy"
+ },
+ "DataAccessOptions": {
+ "description": "Write a Data Access (Gin) log",
+ "type": "object",
+ "properties": {},
+ "id": "DataAccessOptions"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ },
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "AuditConfig"
+ },
"SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
"properties": {
"updateMask": {
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
@@ -307,14 +96,27 @@
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
+ "id": "SetIamPolicyRequest"
},
"CloudAuditOptions": {
"description": "Write a Cloud Audit log",
"type": "object",
- "properties": {},
+ "properties": {
+ "logName": {
+ "enumDescriptions": [
+ "Default. Should not be used.",
+ "Corresponds to \"cloudaudit.googleapis.com/activity\"",
+ "Corresponds to \"cloudaudit.googleapis.com/data_access\""
+ ],
+ "enum": [
+ "UNSPECIFIED_LOG_NAME",
+ "ADMIN_ACTIVITY",
+ "DATA_ACCESS"
+ ],
+ "description": "The log_name to populate in the Cloud Audit Record.",
+ "type": "string"
+ }
+ },
"id": "CloudAuditOptions"
},
"Binding": {
@@ -322,7 +124,7 @@
"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",
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"type": "array",
"items": {
"type": "string"
@@ -335,13 +137,16 @@
},
"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": {
- "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"
@@ -349,43 +154,118 @@
"deployKeyId": {
"description": "ID of the SSH deploy key at the other hosting service.\nRemoving this key from the other service would deauthorize\nGoogle Cloud Source Repositories from mirroring.",
"type": "string"
+ },
+ "url": {
+ "description": "URL of the main repository at the other hosting service.",
+ "type": "string"
}
},
- "id": "MirrorConfig",
- "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or BitBucket."
- },
- "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": "MirrorConfig"
},
"Repo": {
"description": "A repository (or repo) is a Git repository storing versioned source content.",
"type": "object",
"properties": {
- "url": {
- "description": "URL to clone the repository from Google Cloud Source Repositories.",
- "type": "string"
- },
"size": {
- "description": "The size in bytes of the repo.",
+ "description": "The disk usage of the repo, in bytes.\nOnly returned by GetRepo.",
"format": "int64",
"type": "string"
},
"name": {
- "type": "string",
- "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`."
+ "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`. The repo name may contain slashes.\neg, `projects/myproject/repos/name/with/slash`",
+ "type": "string"
},
"mirrorConfig": {
- "$ref": "MirrorConfig",
- "description": "How this repository mirrors a repository managed by another service."
+ "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"
}
},
"id": "Repo"
},
+ "Condition": {
+ "description": "A condition to be met.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "id": "Condition"
+ },
"ListReposResponse": {
- "description": "Response for ListRepos.",
+ "description": "Response for ListRepos. The size is not set in the returned repositories.",
"type": "object",
"properties": {
"repos": {
@@ -394,6 +274,10 @@
"items": {
"$ref": "Repo"
}
+ },
+ "nextPageToken": {
+ "description": "If non-empty, additional repositories exist within the project. These\ncan be retrieved by including this value in the next ListReposRequest's\npage_token field.",
+ "type": "string"
}
},
"id": "ListReposResponse"
@@ -412,85 +296,8 @@
},
"id": "TestIamPermissionsResponse"
},
- "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": {
- "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."
- ],
- "enum": [
- "NO_ATTR",
- "AUTHORITY",
- "ATTRIBUTION",
- "APPROVER",
- "JUSTIFICATION_TYPE"
- ]
- },
- "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"
- ]
- },
- "svc": {
- "description": "Trusted attributes discharged by the service.",
- "type": "string"
- },
- "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"
- },
"CounterOptions": {
+ "description": "Options for counters",
"type": "object",
"properties": {
"metric": {
@@ -502,15 +309,13 @@
"type": "string"
}
},
- "id": "CounterOptions",
- "description": "Options for counters"
+ "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": {
"logType": {
- "description": "The log type that this config enables.",
- "type": "string",
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
@@ -522,7 +327,9 @@
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
- ]
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
},
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
@@ -532,40 +339,12 @@
}
}
},
- "id": "AuditLogConfig",
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging."
+ "id": "AuditLogConfig"
},
"Rule": {
"description": "A rule to be applied in a Policy.",
"type": "object",
"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": {
- "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."
- ],
- "enum": [
- "NO_ACTION",
- "ALLOW",
- "ALLOW_WITH_LOG",
- "DENY",
- "DENY_WITH_LOG",
- "LOG"
- ]
- },
"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",
@@ -597,6 +376,33 @@
"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": {
+ "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."
+ ],
+ "enum": [
+ "NO_ACTION",
+ "ALLOW",
+ "ALLOW_WITH_LOG",
+ "DENY",
+ "DENY_WITH_LOG",
+ "LOG"
+ ]
}
},
"id": "Rule"
@@ -606,12 +412,12 @@
"type": "object",
"properties": {
"dataAccess": {
- "$ref": "DataAccessOptions",
- "description": "Data access options."
+ "description": "Data access options.",
+ "$ref": "DataAccessOptions"
},
"cloudAudit": {
- "$ref": "CloudAuditOptions",
- "description": "Cloud audit options."
+ "description": "Cloud audit options.",
+ "$ref": "CloudAuditOptions"
},
"counter": {
"description": "Counter options.",
@@ -633,77 +439,6 @@
}
},
"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"
- },
- "DataAccessOptions": {
- "properties": {},
- "id": "DataAccessOptions",
- "description": "Write a Data Access (Gin) log",
- "type": "object"
- },
- "AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn 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.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- },
- "exemptedMembers": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "AuditConfig"
}
},
"protocol": "rest",
@@ -715,8 +450,14 @@
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/source.read_write": {
+ "description": "Manage the contents of your source code repositories"
+ },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/source.read_only": {
+ "description": "View the contents of your source code repositories"
}
}
}
@@ -724,5 +465,314 @@
"rootUrl": "https://sourcerepo.googleapis.com/",
"ownerDomain": "google.com",
"name": "sourcerepo",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "title": "Cloud Source Repositories API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "repos": {
+ "methods": {
+ "get": {
+ "description": "Returns information about a repo.",
+ "response": {
+ "$ref": "Repo"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the requested repository. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
+ "path": "v1/{+name}",
+ "id": "sourcerepo.projects.repos.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.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy 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",
+ "id": "sourcerepo.projects.repos.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions"
+ },
+ "delete": {
+ "description": "Deletes a repo.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the repo to delete. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
+ "id": "sourcerepo.projects.repos.delete",
+ "path": "v1/{+name}"
+ },
+ "list": {
+ "flatPath": "v1/projects/{projectsId}/repos",
+ "id": "sourcerepo.projects.repos.list",
+ "path": "v1/{+name}/repos",
+ "description": "Returns all repos belonging to a project. The sizes of the repos are\nnot set by ListRepos. To get the size of a repo, use GetRepo.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListReposResponse"
+ },
+ "parameters": {
+ "name": {
+ "description": "The project ID whose repos should be listed. Values are of the form\n`projects/\u003cproject\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Resume listing repositories where a prior ListReposResponse\nleft off. This is an opaque token that must be obtained from\na recent, prior ListReposResponse's next_page_token field.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of repositories to return; between 1 and 500.\nIf not set or zero, defaults to 100 at the server.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ]
+ },
+ "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/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "sourcerepo.projects.repos.setIamPolicy"
+ },
+ "create": {
+ "description": "Creates a repo in the given project with the given name.\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.",
+ "request": {
+ "$ref": "Repo"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Repo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The project in which to create the repo. Values are of the form\n`projects/\u003cproject\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos",
+ "id": "sourcerepo.projects.repos.create",
+ "path": "v1/{+parent}/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",
+ "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",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "sourcerepo.projects.repos.getIamPolicy"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ }
+ }
}
diff --git a/sourcerepo/v1/sourcerepo-gen.go b/sourcerepo/v1/sourcerepo-gen.go
index 67b829f..f9764f5 100644
--- a/sourcerepo/v1/sourcerepo-gen.go
+++ b/sourcerepo/v1/sourcerepo-gen.go
@@ -1,6 +1,6 @@
// Package sourcerepo provides access to the Cloud Source Repositories API.
//
-// See https://cloud.google.com/eap/cloud-repositories/cloud-sourcerepo-api
+// See https://cloud.google.com/source-repositories/docs/apis
//
// Usage example:
//
@@ -49,6 +49,12 @@
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
+
+ // View the contents of your source code repositories
+ SourceReadOnlyScope = "https://www.googleapis.com/auth/source.read_only"
+
+ // Manage the contents of your source code repositories
+ SourceReadWriteScope = "https://www.googleapis.com/auth/source.read_write"
)
func New(client *http.Client) (*Service, error) {
@@ -100,7 +106,7 @@
// 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.
+// An AuditConfig must have one or more AuditLogConfigs.
//
// If there are AuditConfigs for both `allServices` and a specific
// service,
@@ -281,6 +287,7 @@
// 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
@@ -320,6 +327,37 @@
// CloudAuditOptions: Write a Cloud Audit log
type CloudAuditOptions struct {
+ // LogName: The log_name to populate in the Cloud Audit Record.
+ //
+ // Possible values:
+ // "UNSPECIFIED_LOG_NAME" - Default. Should not be used.
+ // "ADMIN_ACTIVITY" - Corresponds to
+ // "cloudaudit.googleapis.com/activity"
+ // "DATA_ACCESS" - Corresponds to
+ // "cloudaudit.googleapis.com/data_access"
+ LogName string `json:"logName,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "LogName") 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. "LogName") 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 *CloudAuditOptions) MarshalJSON() ([]byte, error) {
+ type noMethod CloudAuditOptions
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Condition: A condition to be met.
@@ -473,8 +511,16 @@
googleapi.ServerResponse `json:"-"`
}
-// ListReposResponse: Response for ListRepos.
+// ListReposResponse: Response for ListRepos. The size is not set in
+// the returned repositories.
type ListReposResponse struct {
+ // NextPageToken: If non-empty, additional repositories exist within the
+ // project. These
+ // can be retrieved by including this value in the next
+ // ListReposRequest's
+ // page_token field.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
// Repos: The listed repos.
Repos []*Repo `json:"repos,omitempty"`
@@ -482,7 +528,7 @@
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Repos") to
+ // 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
@@ -490,10 +536,10 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Repos") 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. "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:"-"`
@@ -704,10 +750,13 @@
// Name: Resource name of the repository, of the
// form
- // `projects/<project>/repos/<repo>`.
+ // `projects/<project>/repos/<repo>`. The repo name may contain
+ // slashes.
+ // eg, `projects/myproject/repos/name/with/slash`
Name string `json:"name,omitempty"`
- // Size: The size in bytes of the repo.
+ // Size: The disk usage of the repo, in bytes.
+ // Only returned by GetRepo.
Size int64 `json:"size,omitempty,string"`
// Url: URL to clone the repository from Google Cloud Source
@@ -935,7 +984,7 @@
header_ http.Header
}
-// Create: Creates a repo in the given project with the given name..
+// Create: Creates a repo in the given project with the given name.
//
// If the named repository already exists, `CreateRepo`
// returns
@@ -1033,7 +1082,7 @@
}
return ret, nil
// {
- // "description": "Creates a repo in the given project with the given name..\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.",
+ // "description": "Creates a repo in the given project with the given name.\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.",
// "flatPath": "v1/projects/{projectsId}/repos",
// "httpMethod": "POST",
// "id": "sourcerepo.projects.repos.create",
@@ -1057,7 +1106,9 @@
// "$ref": "Repo"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/source.read_only",
+ // "https://www.googleapis.com/auth/source.read_write"
// ]
// }
@@ -1182,7 +1233,9 @@
// "$ref": "Empty"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/source.read_only",
+ // "https://www.googleapis.com/auth/source.read_write"
// ]
// }
@@ -1321,7 +1374,9 @@
// "$ref": "Repo"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/source.read_only",
+ // "https://www.googleapis.com/auth/source.read_write"
// ]
// }
@@ -1463,7 +1518,9 @@
// "$ref": "Policy"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/source.read_only",
+ // "https://www.googleapis.com/auth/source.read_write"
// ]
// }
@@ -1480,13 +1537,32 @@
header_ http.Header
}
-// List: Returns all repos belonging to a project.
+// List: Returns all repos belonging to a project. The sizes of the
+// repos are
+// not set by ListRepos. To get the size of a repo, use GetRepo.
func (r *ProjectsReposService) List(name string) *ProjectsReposListCall {
c := &ProjectsReposListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
return c
}
+// PageSize sets the optional parameter "pageSize": Maximum number of
+// repositories to return; between 1 and 500.
+// If not set or zero, defaults to 100 at the server.
+func (c *ProjectsReposListCall) PageSize(pageSize int64) *ProjectsReposListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": Resume listing
+// repositories where a prior ListReposResponse
+// left off. This is an opaque token that must be obtained from
+// a recent, prior ListReposResponse's next_page_token field.
+func (c *ProjectsReposListCall) PageToken(pageToken string) *ProjectsReposListCall {
+ 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.
@@ -1581,7 +1657,7 @@
}
return ret, nil
// {
- // "description": "Returns all repos belonging to a project.",
+ // "description": "Returns all repos belonging to a project. The sizes of the repos are\nnot set by ListRepos. To get the size of a repo, use GetRepo.",
// "flatPath": "v1/projects/{projectsId}/repos",
// "httpMethod": "GET",
// "id": "sourcerepo.projects.repos.list",
@@ -1595,6 +1671,17 @@
// "pattern": "^projects/[^/]+$",
// "required": true,
// "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "Maximum number of repositories to return; between 1 and 500.\nIf not set or zero, defaults to 100 at the server.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "Resume listing repositories where a prior ListReposResponse\nleft off. This is an opaque token that must be obtained from\na recent, prior ListReposResponse's next_page_token field.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "v1/{+name}/repos",
@@ -1602,12 +1689,35 @@
// "$ref": "ListReposResponse"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/source.read_only",
+ // "https://www.googleapis.com/auth/source.read_write"
// ]
// }
}
+// 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 *ProjectsReposListCall) Pages(ctx context.Context, f func(*ListReposResponse) 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 "sourcerepo.projects.repos.setIamPolicy":
type ProjectsReposSetIamPolicyCall struct {
@@ -1739,7 +1849,9 @@
// "$ref": "Policy"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/source.read_only",
+ // "https://www.googleapis.com/auth/source.read_write"
// ]
// }
@@ -1878,7 +1990,9 @@
// "$ref": "TestIamPermissionsResponse"
// },
// "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/source.read_only",
+ // "https://www.googleapis.com/auth/source.read_write"
// ]
// }
diff --git a/spanner/v1/spanner-api.json b/spanner/v1/spanner-api.json
index ced9e23..125414a 100644
--- a/spanner/v1/spanner-api.json
+++ b/spanner/v1/spanner-api.json
@@ -1,22 +1,1009 @@
{
- "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": "20170425",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "Operation": {
+ "RollbackRequest": {
"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.",
+ "transactionId": {
+ "description": "Required. The transaction to roll back.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "RollbackRequest",
+ "description": "The request for Rollback.",
+ "type": "object"
+ },
+ "Transaction": {
+ "properties": {
+ "id": {
+ "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use read-only transactions do not have IDs, because\nsingle-use transactions do not support multiple requests.",
+ "format": "byte",
+ "type": "string"
+ },
+ "readTimestamp": {
+ "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Transaction",
+ "description": "A transaction.",
+ "type": "object"
+ },
+ "UpdateDatabaseDdlMetadata": {
+ "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",
+ "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "properties": {
+ "name": {
+ "description": "The name of the field. For reads, this is the column name. For\nSQL queries, it is the column alias (e.g., `\"Word\"` in the\nquery `\"SELECT 'hello' AS Word\"`), or the column name (e.g.,\n`\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some\ncolumns might have an empty name (e.g., !\"SELECT\nUPPER(ColName)\"`). Note that a query result can contain\nmultiple fields with the same name.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the field.",
+ "$ref": "Type"
+ }
+ },
+ "id": "Field",
+ "description": "Message representing a single field of a struct.",
+ "type": "object"
+ },
+ "ResultSetStats": {
+ "description": "Additional statistics about a ResultSet or PartialResultSet.",
+ "type": "object",
+ "properties": {
+ "queryPlan": {
+ "$ref": "QueryPlan",
+ "description": "QueryPlan for the query associated with this result."
+ },
+ "queryStats": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Aggregated statistics from the execution of the query. Only present when\nthe query is profiled. For example, a query could return the statistics as\nfollows:\n\n {\n \"rows_returned\": \"3\",\n \"elapsed_time\": \"1.22 secs\",\n \"cpu_time\": \"1.19 secs\"\n }",
+ "type": "object"
+ }
+ },
+ "id": "ResultSetStats"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "REQUIRED: The set of permissions to check for 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "CommitResponse": {
+ "description": "The response for Commit.",
+ "type": "object",
+ "properties": {
+ "commitTimestamp": {
+ "description": "The Cloud Spanner timestamp at which the transaction committed.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "CommitResponse"
+ },
+ "Type": {
+ "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": {
+ "$ref": "StructType",
+ "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields."
+ },
+ "arrayElementType": {
+ "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements.",
+ "$ref": "Type"
+ },
+ "code": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Encoded as JSON `true` or `false`.",
+ "Encoded as `string`, in decimal format.",
+ "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.",
+ "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.",
+ "Encoded as `string` in RFC 3339 date format.",
+ "Encoded as `string`.",
+ "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.",
+ "Encoded as `list`, where the list elements are represented\naccording to array_element_type.",
+ "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
+ ],
+ "enum": [
+ "TYPE_CODE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "FLOAT64",
+ "TIMESTAMP",
+ "DATE",
+ "STRING",
+ "BYTES",
+ "ARRAY",
+ "STRUCT"
+ ],
+ "description": "Required. The TypeCode for this type.",
+ "type": "string"
+ }
+ },
+ "id": "Type"
+ },
+ "PlanNode": {
+ "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }",
+ "type": "object"
+ },
+ "executionStats": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc.",
+ "type": "object"
+ },
+ "shortRepresentation": {
+ "description": "Condensed representation for SCALAR nodes.",
+ "$ref": "ShortRepresentation"
+ },
+ "index": {
+ "description": "The `PlanNode`'s index in node list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "displayName": {
+ "description": "The display name for the node.",
+ "type": "string"
+ },
+ "kind": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Denotes a Relational operator node in the expression tree. Relational\noperators represent iterative processing of rows during query execution.\nFor example, a `TableScan` operation that reads rows from a table.",
+ "Denotes a Scalar node in the expression tree. Scalar nodes represent\nnon-iterable entities in the query plan. For example, constants or\narithmetic operators appearing inside predicate expressions or references\nto column names."
+ ],
+ "enum": [
+ "KIND_UNSPECIFIED",
+ "RELATIONAL",
+ "SCALAR"
+ ],
+ "description": "Used to determine the type of node. May be needed for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\nSCALAR node, it will have a condensed representation\nwhich can be used to directly embed a description of the node in its\nparent.",
+ "type": "string"
+ },
+ "childLinks": {
+ "description": "List of child node `index`es and their relationship to this parent.",
+ "type": "array",
+ "items": {
+ "$ref": "ChildLink"
+ }
+ }
+ },
+ "id": "PlanNode"
+ },
+ "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.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ }
+ },
+ "id": "AuditConfig"
+ },
+ "CreateInstanceMetadata": {
+ "description": "Metadata type for the operation returned by\nCreateInstance.",
+ "type": "object",
+ "properties": {
+ "cancelTime": {
+ "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The time at which this operation failed or was completed successfully.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "instance": {
+ "$ref": "Instance",
+ "description": "The instance being created."
+ },
+ "startTime": {
+ "description": "The time at which the\nCreateInstance request was\nreceived.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "CreateInstanceMetadata"
+ },
+ "ChildLink": {
+ "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of the link. For example, in Hash Joins this could be used to\ndistinguish between the build child and the probe child, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.",
+ "type": "string"
+ },
+ "childIndex": {
+ "description": "The node to which the link points.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "variable": {
+ "description": "Only present if the child node is SCALAR and corresponds\nto an output variable of the parent node. The field carries the name of\nthe output variable.\nFor example, a `TableScan` operator that reads rows from a table will\nhave child links to the `SCALAR` nodes representing the output variables\ncreated for each column that is read by the operator. The corresponding\n`variable` fields will be set to the variable names assigned to the\ncolumns.",
+ "type": "string"
+ }
+ },
+ "id": "ChildLink"
+ },
+ "CloudAuditOptions": {
+ "properties": {},
+ "id": "CloudAuditOptions",
+ "description": "Write a Cloud Audit log",
+ "type": "object"
+ },
+ "Delete": {
+ "properties": {
+ "table": {
+ "description": "Required. The table whose rows will be deleted.",
+ "type": "string"
+ },
+ "keySet": {
+ "description": "Required. The primary keys of the rows within table to delete.",
+ "$ref": "KeySet"
+ }
+ },
+ "id": "Delete",
+ "description": "Arguments to delete operations.",
+ "type": "object"
+ },
+ "ListInstanceConfigsResponse": {
+ "description": "The response for ListInstanceConfigs.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",
+ "type": "string"
+ },
+ "instanceConfigs": {
+ "description": "The list of requested instance configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "InstanceConfig"
+ }
+ }
+ },
+ "id": "ListInstanceConfigsResponse"
+ },
+ "BeginTransactionRequest": {
+ "properties": {
+ "options": {
+ "description": "Required. Options for the new transaction.",
+ "$ref": "TransactionOptions"
+ }
+ },
+ "id": "BeginTransactionRequest",
+ "description": "The request for BeginTransaction.",
+ "type": "object"
+ },
+ "CommitRequest": {
+ "description": "The request for Commit.",
+ "type": "object",
+ "properties": {
+ "singleUseTransaction": {
+ "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead.",
+ "$ref": "TransactionOptions"
+ },
+ "mutations": {
+ "description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",
+ "type": "array",
+ "items": {
+ "$ref": "Mutation"
+ }
+ },
+ "transactionId": {
+ "description": "Commit a previously-started transaction.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "CommitRequest"
+ },
+ "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"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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"
+ },
+ "CreateDatabaseMetadata": {
+ "description": "Metadata type for the operation returned by\nCreateDatabase.",
+ "type": "object",
+ "properties": {
+ "database": {
+ "description": "The database being created.",
+ "type": "string"
+ }
+ },
+ "id": "CreateDatabaseMetadata"
+ },
+ "LogConfig": {
+ "properties": {
+ "cloudAudit": {
+ "description": "Cloud audit options.",
+ "$ref": "CloudAuditOptions"
+ },
+ "counter": {
+ "$ref": "CounterOptions",
+ "description": "Counter options."
+ },
+ "dataAccess": {
+ "$ref": "DataAccessOptions",
+ "description": "Data access options."
+ }
+ },
+ "id": "LogConfig",
+ "description": "Specifies what kind of log the caller must write",
+ "type": "object"
+ },
+ "Session": {
+ "properties": {
+ "name": {
+ "description": "Required. The name of the session.",
+ "type": "string"
+ }
+ },
+ "id": "Session",
+ "description": "A session in the Cloud Spanner API.",
+ "type": "object"
+ },
+ "KeyRange": {
+ "properties": {
+ "endClosed": {
+ "description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "startClosed": {
+ "description": "If the start is closed, then the range includes all rows whose\nfirst `len(start_closed)` key columns exactly match `start_closed`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "startOpen": {
+ "description": "If the start is open, then the range excludes rows whose first\n`len(start_open)` key columns exactly match `start_open`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "endOpen": {
+ "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "id": "KeyRange",
+ "description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` clause names two\ncolumns, each `UserEvents` key has two elements; the first is the\n`UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, the following range includes all events for `\"Bob\"` that\noccurred during and after the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end_closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve events before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table:\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_closed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [\"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.",
+ "type": "object"
+ },
+ "ListInstancesResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",
+ "type": "string"
+ },
+ "instances": {
+ "description": "The list of requested instances.",
+ "type": "array",
+ "items": {
+ "$ref": "Instance"
+ }
+ }
+ },
+ "id": "ListInstancesResponse",
+ "description": "The response for ListInstances.",
+ "type": "object"
+ },
+ "ShortRepresentation": {
+ "properties": {
+ "description": {
+ "description": "A string representation of the expression subtree rooted at this node.",
+ "type": "string"
+ },
+ "subqueries": {
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": "A mapping of (subquery variable name) -\u003e (subquery node id) for cases\nwhere the `description` string of this node references a `SCALAR`\nsubquery contained in the expression subtree rooted at this node. The\nreferenced `SCALAR` subquery may not necessarily be a direct child of\nthis node.",
+ "type": "object"
+ }
+ },
+ "id": "ShortRepresentation",
+ "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
+ "type": "object"
+ },
+ "InstanceConfig": {
+ "properties": {
+ "name": {
+ "description": "A unique identifier for the instance configuration. Values\nare of the form\n`projects/\u003cproject\u003e/instanceConfigs/a-z*`",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The name of this instance configuration as it appears in UIs.",
+ "type": "string"
+ }
+ },
+ "id": "InstanceConfig",
+ "description": "A possible configuration for a Cloud Spanner instance. Configurations\ndefine the geographic placement of nodes and their replication.",
+ "type": "object"
+ },
+ "UpdateInstanceRequest": {
+ "properties": {
+ "instance": {
+ "description": "Required. The instance to update, which must always include the instance\nname. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.",
+ "$ref": "Instance"
+ },
+ "fieldMask": {
+ "description": "Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.\nThe field mask must always be specified; this prevents any future fields in\n[][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know\nabout them.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateInstanceRequest",
+ "description": "The request for UpdateInstance.",
+ "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"
+ },
+ "TransactionOptions": {
+ "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."
+ },
+ "readOnly": {
+ "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",
+ "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": {
+ "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.\nIf the database ID is a reserved word or if it contains a hyphen, the\ndatabase ID must be enclosed in backticks (`` ` ``).",
+ "type": "string"
+ }
+ },
+ "id": "CreateDatabaseRequest",
+ "description": "The request for CreateDatabase.",
+ "type": "object"
+ },
+ "CreateInstanceRequest": {
+ "description": "The request for CreateInstance.",
+ "type": "object",
+ "properties": {
+ "instance": {
+ "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `\u003cparent\u003e/instances/\u003cinstance_id\u003e`.",
+ "$ref": "Instance"
+ },
+ "instanceId": {
+ "description": "Required. The ID of the instance to create. Valid identifiers are of the\nform `a-z*[a-z0-9]` and must be between 6 and 30 characters in\nlength.",
+ "type": "string"
+ }
+ },
+ "id": "CreateInstanceRequest"
+ },
+ "Condition": {
+ "description": "A condition to be met.",
+ "type": "object",
+ "properties": {
+ "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"
+ ]
+ },
+ "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": {
+ "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).",
+ "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",
+ "SECURITY_REALM",
+ "APPROVER",
+ "JUSTIFICATION_TYPE"
+ ],
+ "description": "Trusted attributes supplied by the IAM system.",
+ "type": "string"
+ }
+ },
+ "id": "Condition"
+ },
+ "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"
+ },
+ "ReadOnly": {
+ "properties": {
+ "strong": {
+ "description": "Read at a timestamp where all previously committed transactions\nare visible.",
"type": "boolean"
},
+ "minReadTimestamp": {
+ "description": "Executes all reads at a timestamp \u003e= `min_read_timestamp`.\n\nThis is useful for requesting fresher data than some previous\nread, or data that is fresh enough to observe the effects of some\npreviously committed transaction whose timestamp is known.\n\nNote that this option can only be used in single-use transactions.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "maxStaleness": {
+ "description": "Read data at a timestamp \u003e= `NOW - max_staleness`\nseconds. Guarantees that all writes that have committed more\nthan the specified number of seconds ago are visible. Because\nCloud Spanner chooses the exact timestamp, this mode works even if\nthe client's local clock is substantially skewed from Cloud Spanner\ncommit timestamps.\n\nUseful for reading the freshest data available at a nearby\nreplica, while bounding the possible staleness if the local\nreplica has fallen behind.\n\nNote that this option can only be used in single-use\ntransactions.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "readTimestamp": {
+ "description": "Executes all reads at the given timestamp. Unlike other modes,\nreads at a specific timestamp are repeatable; the same read at\nthe same timestamp always returns the same data. If the\ntimestamp is in the future, the read will block until the\nspecified timestamp, modulo the read's deadline.\n\nUseful for large scale consistent reads such as mapreduces, or\nfor coordinating many reads against a consistent snapshot of the\ndata.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "returnReadTimestamp": {
+ "description": "If true, the Cloud Spanner-selected read timestamp is included in\nthe Transaction message that describes the transaction.",
+ "type": "boolean"
+ },
+ "exactStaleness": {
+ "description": "Executes all reads at a timestamp that is `exact_staleness`\nold. The timestamp is chosen soon after the read is started.\n\nGuarantees that all writes that have committed more than the\nspecified number of seconds ago are visible. Because Cloud Spanner\nchooses the exact timestamp, this mode works even if the client's\nlocal clock is substantially skewed from Cloud Spanner commit\ntimestamps.\n\nUseful for reading at nearby replicas without the distributed\ntimestamp negotiation overhead of `max_staleness`.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "ReadOnly",
+ "description": "Options for read-only transactions.",
+ "type": "object"
+ },
+ "ExecuteSqlRequest": {
+ "properties": {
+ "params": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The SQL query string can contain parameter placeholders. A parameter\nplaceholder consists of `'@'` followed by the parameter\nname. Parameter names consist of any combination of letters,\nnumbers, and underscores.\n\nParameters can appear anywhere that a literal value is expected. The same\nparameter name can be used more than once, for example:\n `\"WHERE id \u003e @msg_id AND id \u003c @msg_id + 100\"`\n\nIt is an error to execute an SQL query with unbound parameters.\n\nParameter values are specified using `params`, which is a JSON\nobject whose keys are parameter names, and whose values are the\ncorresponding parameter values.",
+ "type": "object"
+ },
+ "queryMode": {
+ "enumDescriptions": [
+ "The default mode where only the query result, without any information\nabout the query plan is returned.",
+ "This mode returns only the query plan, without any result rows or\nexecution statistics information.",
+ "This mode returns both the query plan and the execution statistics along\nwith the result rows."
+ ],
+ "enum": [
+ "NORMAL",
+ "PLAN",
+ "PROFILE"
+ ],
+ "description": "Used to control the amount of debugging information returned in\nResultSetStats.",
+ "type": "string"
+ },
+ "transaction": {
+ "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 SQL query\nexecution, `resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the new SQL query execution to resume where the last one left\noff. The rest of the request parameters must exactly match the\nrequest that yielded this token.",
+ "format": "byte",
+ "type": "string"
+ },
+ "paramTypes": {
+ "additionalProperties": {
+ "$ref": "Type"
+ },
+ "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.",
+ "type": "object"
+ },
+ "sql": {
+ "description": "Required. The SQL query string.",
+ "type": "string"
+ }
+ },
+ "id": "ExecuteSqlRequest",
+ "description": "The request for ExecuteSql and\nExecuteStreamingSql.",
+ "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"
+ },
+ "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",
+ "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",
+ "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"
+ },
+ "ReadRequest": {
+ "description": "The request for Read and\nStreamingRead.",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.",
+ "format": "int64",
+ "type": "string"
+ },
+ "index": {
+ "description": "If non-empty, the name of an index on table. This index is\nused instead of the table primary key when interpreting key_set\nand sorting result rows. See key_set for further information.",
+ "type": "string"
+ },
+ "keySet": {
+ "$ref": "KeySet",
+ "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the\nprimary keys of the rows in table to be yielded, unless index\nis present. If index is present, then key_set instead names\nindex keys in index.\n\nRows are yielded in table primary key order (if index is empty)\nor index key order (if index is non-empty).\n\nIt is not an error for the `key_set` to name rows that do not\nexist in the database. Read yields nothing for nonexistent rows."
+ },
+ "columns": {
+ "description": "The columns of table to be returned for each row matching\nthis request.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transaction": {
+ "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.",
+ "format": "byte",
+ "type": "string"
+ },
+ "table": {
+ "description": "Required. The name of the table in the database to be read.",
+ "type": "string"
+ }
+ },
+ "id": "ReadRequest"
+ },
+ "Write": {
+ "description": "Arguments to insert, update, insert_or_update, and\nreplace operations.",
+ "type": "object",
+ "properties": {
+ "table": {
+ "description": "Required. The table whose rows will be written.",
+ "type": "string"
+ },
+ "columns": {
+ "description": "The names of the columns in table to be written.\n\nThe list of columns must contain enough columns to allow\nCloud Spanner to derive values for all primary key columns in the\nrow(s) to be modified.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "values": {
+ "description": "The values to be written. `values` can contain more than one\nlist of values. If it does, then multiple rows are written, one\nfor each entry in `values`. Each list in `values` must have\nexactly as many entries as there are entries in columns\nabove. Sending multiple lists is equivalent to sending multiple\n`Mutation`s, each containing one `values` entry and repeating\ntable and columns. Individual values in each list are\nencoded as described here.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "Write"
+ },
+ "DataAccessOptions": {
+ "description": "Write a Data Access (Gin) log",
+ "type": "object",
+ "properties": {},
+ "id": "DataAccessOptions"
+ },
+ "ReadWrite": {
+ "description": "Options for read-write transactions.",
+ "type": "object",
+ "properties": {},
+ "id": "ReadWrite"
+ },
+ "Operation": {
+ "properties": {
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -30,8 +1017,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": {
@@ -40,6 +1027,10 @@
},
"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",
@@ -47,13 +1038,7 @@
"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",
@@ -69,16 +1054,20 @@
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
- "id": "Status"
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` 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"
},
"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",
@@ -90,13 +1079,15 @@
}
},
"metadata": {
- "$ref": "ResultSetMetadata",
- "description": "Metadata about the result set, such as row type information."
+ "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"
+ "id": "ResultSet"
},
"Binding": {
"description": "Associates `members` with a `role`.",
@@ -138,6 +1129,21 @@
"description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.",
"type": "object",
"properties": {
+ "chunkedValue": {
+ "description": "If true, then the final value in values is chunked, and must\nbe combined with more values from subsequent `PartialResultSet`s\nto obtain a complete field value.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "description": "Metadata about the result set, such as row type information.\nOnly present in the first response.",
+ "$ref": "ResultSetMetadata"
+ },
+ "values": {
+ "description": "A streamed result set consists of a stream of values, which might\nbe split into many `PartialResultSet` messages to accommodate\nlarge rows and/or large values. Every N complete values defines a\nrow, where N is equal to the number of entries in\nmetadata.row_type.fields.\n\nMost values are encoded based on type as described\nhere.\n\nIt is possible that the last value in values is \"chunked\",\nmeaning that the rest of the value is sent in subsequent\n`PartialResultSet`(s). This is denoted by the chunked_value\nfield. Two or more chunked values can be merged to form a\ncomplete value as follows:\n\n * `bool/number/null`: cannot be chunked\n * `string`: concatenate the strings\n * `list`: concatenate the lists. If the last element in a list is a\n `string`, `list`, or `object`, merge it with the first element in\n the next list by applying these rules recursively.\n * `object`: concatenate the (field name, field value) pairs. If a\n field name is duplicated, then apply these rules recursively\n to merge the field values.\n\nSome examples of merging:\n\n # Strings are concatenated.\n \"foo\", \"bar\" =\u003e \"foobar\"\n\n # Lists of non-strings are concatenated.\n [2, 3], [4] =\u003e [2, 3, 4]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are strings.\n [\"a\", \"b\"], [\"c\", \"d\"] =\u003e [\"a\", \"bc\", \"d\"]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are lists. Recursively, the last and first elements\n # of the inner lists are merged because they are strings.\n [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] =\u003e [\"a\", [\"b\", \"cd\"], \"e\"]\n\n # Non-overlapping object fields are combined.\n {\"a\": \"1\"}, {\"b\": \"2\"} =\u003e {\"a\": \"1\", \"b\": 2\"}\n\n # Overlapping object fields are merged.\n {\"a\": \"1\"}, {\"a\": \"2\"} =\u003e {\"a\": \"12\"}\n\n # Examples of merging objects containing lists of strings.\n {\"a\": [\"1\"]}, {\"a\": [\"2\"]} =\u003e {\"a\": [\"12\"]}\n\nFor a more complete example, suppose a streaming SQL query is\nyielding a result set whose rows contain a single string\nfield. The following `PartialResultSet`s might be yielded:\n\n {\n \"metadata\": { ... }\n \"values\": [\"Hello\", \"W\"]\n \"chunked_value\": true\n \"resume_token\": \"Af65...\"\n }\n {\n \"values\": [\"orl\"]\n \"chunked_value\": true\n \"resume_token\": \"Bqp2...\"\n }\n {\n \"values\": [\"d\"]\n \"resume_token\": \"Zx1B...\"\n }\n\nThis sequence of `PartialResultSet`s encodes two rows, one\ncontaining the field value `\"Hello\"`, and a second containing the\nfield value `\"World\" = \"W\" + \"orl\" + \"d\"`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
"resumeToken": {
"description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.",
"format": "byte",
@@ -146,52 +1152,13 @@
"stats": {
"description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream.",
"$ref": "ResultSetStats"
- },
- "chunkedValue": {
- "description": "If true, then the final value in values is chunked, and must\nbe combined with more values from subsequent `PartialResultSet`s\nto obtain a complete field value.",
- "type": "boolean"
- },
- "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"
- }
}
},
"id": "PartialResultSet"
},
- "UpdateInstanceMetadata": {
- "description": "Metadata type for the operation returned by\nUpdateInstance.",
- "type": "object",
- "properties": {
- "cancelTime": {
- "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
- "format": "google-datetime",
- "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"
- },
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -205,24 +1172,48 @@
}
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse"
+ },
+ "UpdateInstanceMetadata": {
+ "properties": {
+ "cancelTime": {
+ "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The time at which this operation failed or was completed successfully.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "instance": {
+ "description": "The desired end state of the update.",
+ "$ref": "Instance"
+ },
+ "startTime": {
+ "description": "The time at which UpdateInstance\nrequest was received.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "UpdateInstanceMetadata",
+ "description": "Metadata type for the operation returned by\nUpdateInstance.",
"type": "object"
},
"ResultSetMetadata": {
+ "description": "Metadata about a ResultSet or PartialResultSet.",
+ "type": "object",
"properties": {
"rowType": {
"$ref": "StructType",
"description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserName FROM\nUsers\"` could return a `row_type` value like:\n\n \"fields\": [\n { \"name\": \"UserId\", \"type\": { \"code\": \"INT64\" } },\n { \"name\": \"UserName\", \"type\": { \"code\": \"STRING\" } },\n ]"
},
"transaction": {
- "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here.",
- "$ref": "Transaction"
+ "$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",
- "description": "Metadata about a ResultSet or PartialResultSet.",
- "type": "object"
+ "id": "ResultSetMetadata"
},
"TransactionSelector": {
"properties": {
@@ -244,9 +1235,34 @@
"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": {
+ "delete": {
+ "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present.",
+ "$ref": "Delete"
+ },
+ "insert": {
+ "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`.",
+ "$ref": "Write"
+ },
+ "insertOrUpdate": {
+ "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved.",
+ "$ref": "Write"
+ },
+ "update": {
+ "$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"
+ }
+ },
+ "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.",
@@ -270,34 +1286,9 @@
}
}
},
- "id": "KeySet"
- },
- "Mutation": {
- "description": "A modification to one or more Cloud Spanner rows. Mutations can be\napplied to a Cloud Spanner database by sending them in a\nCommit call.",
- "type": "object",
- "properties": {
- "delete": {
- "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present.",
- "$ref": "Delete"
- },
- "insert": {
- "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`.",
- "$ref": "Write"
- },
- "insertOrUpdate": {
- "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved.",
- "$ref": "Write"
- },
- "update": {
- "$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"
- }
- },
- "id": "Mutation"
+ "id": "KeySet",
+ "description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.",
+ "type": "object"
},
"GetDatabaseDdlResponse": {
"description": "The response for GetDatabaseDdl.",
@@ -342,6 +1333,28 @@
"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": {
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "CREATING",
+ "READY"
+ ],
+ "description": "Output only. The current instance state. For\nCreateInstance, the state must be\neither omitted or set to `CREATING`. For\nUpdateInstance, the state must be\neither omitted or set to `READY`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.",
+ "The instance is fully created and ready to do work such as\ncreating databases."
+ ]
+ },
+ "name": {
+ "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
+ "type": "string"
+ },
"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"
@@ -357,28 +1370,6 @@
},
"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"
}
},
"id": "Instance"
@@ -393,15 +1384,13 @@
"type": "string"
},
"policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
"id": "SetIamPolicyRequest"
},
"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.",
@@ -415,1014 +1404,16 @@
}
}
},
- "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": {
- "id": {
- "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use read-only transactions do not have IDs, because\nsingle-use transactions do not support multiple requests.",
- "format": "byte",
- "type": "string"
- },
- "readTimestamp": {
- "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Transaction"
- },
- "UpdateDatabaseDdlMetadata": {
- "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",
- "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
- "type": "object"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "Field": {
- "properties": {
- "name": {
- "description": "The name of the field. For reads, this is the column name. For\nSQL queries, it is the column alias (e.g., `\"Word\"` in the\nquery `\"SELECT 'hello' AS Word\"`), or the column name (e.g.,\n`\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some\ncolumns might have an empty name (e.g., !\"SELECT\nUPPER(ColName)\"`). Note that a query result can contain\nmultiple fields with the same name.",
- "type": "string"
- },
- "type": {
- "$ref": "Type",
- "description": "The type of the field."
- }
- },
- "id": "Field",
- "description": "Message representing a single field of a struct.",
- "type": "object"
- },
- "ResultSetStats": {
- "description": "Additional statistics about a ResultSet or PartialResultSet.",
- "type": "object",
- "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"
- },
- "TestIamPermissionsRequest": {
- "properties": {
- "permissions": {
- "description": "REQUIRED: The set of permissions to check for 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
- },
- "CommitResponse": {
- "description": "The response for Commit.",
- "type": "object",
- "properties": {
- "commitTimestamp": {
- "description": "The Cloud Spanner timestamp at which the transaction committed.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "CommitResponse"
- },
- "Type": {
- "properties": {
- "structType": {
- "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields.",
- "$ref": "StructType"
- },
- "arrayElementType": {
- "$ref": "Type",
- "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."
- },
- "code": {
- "enum": [
- "TYPE_CODE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "FLOAT64",
- "TIMESTAMP",
- "DATE",
- "STRING",
- "BYTES",
- "ARRAY",
- "STRUCT"
- ],
- "description": "Required. The TypeCode for this type.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Encoded as JSON `true` or `false`.",
- "Encoded as `string`, in decimal format.",
- "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.",
- "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.",
- "Encoded as `string` in RFC 3339 date format.",
- "Encoded as `string`.",
- "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.",
- "Encoded as `list`, where the list elements are represented\naccording to array_element_type.",
- "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
- ]
- }
- },
- "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": {
- "properties": {
- "executionStats": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc.",
- "type": "object"
- },
- "shortRepresentation": {
- "description": "Condensed representation for SCALAR nodes.",
- "$ref": "ShortRepresentation"
- },
- "index": {
- "description": "The `PlanNode`'s index in node list.",
- "format": "int32",
- "type": "integer"
- },
- "kind": {
- "enum": [
- "KIND_UNSPECIFIED",
- "RELATIONAL",
- "SCALAR"
- ],
- "description": "Used to determine the type of node. May be needed for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\nSCALAR node, it will have a condensed representation\nwhich can be used to directly embed a description of the node in its\nparent.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Denotes a Relational operator node in the expression tree. Relational\noperators represent iterative processing of rows during query execution.\nFor example, a `TableScan` operation that reads rows from a table.",
- "Denotes a Scalar node in the expression tree. Scalar nodes represent\nnon-iterable entities in the query plan. For example, constants or\narithmetic operators appearing inside predicate expressions or references\nto column names."
- ]
- },
- "displayName": {
- "description": "The display name for the node.",
- "type": "string"
- },
- "childLinks": {
- "description": "List of child node `index`es and their relationship to this parent.",
- "type": "array",
- "items": {
- "$ref": "ChildLink"
- }
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }",
- "type": "object"
- }
- },
- "id": "PlanNode",
- "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
- "type": "object"
- },
- "CreateInstanceMetadata": {
- "properties": {
- "instance": {
- "description": "The instance being created.",
- "$ref": "Instance"
- },
- "startTime": {
- "description": "The time at which the\nCreateInstance request was\nreceived.",
- "format": "google-datetime",
- "type": "string"
- },
- "cancelTime": {
- "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "The time at which this operation failed or was completed successfully.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "CreateInstanceMetadata",
- "description": "Metadata type for the operation returned by\nCreateInstance.",
- "type": "object"
- },
- "AuditConfig": {
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- },
- "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.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object"
- },
- "ChildLink": {
- "properties": {
- "childIndex": {
- "description": "The node to which the link points.",
- "format": "int32",
- "type": "integer"
- },
- "variable": {
- "description": "Only present if the child node is SCALAR and corresponds\nto an output variable of the parent node. The field carries the name of\nthe output variable.\nFor example, a `TableScan` operator that reads rows from a table will\nhave child links to the `SCALAR` nodes representing the output variables\ncreated for each column that is read by the operator. The corresponding\n`variable` fields will be set to the variable names assigned to the\ncolumns.",
- "type": "string"
- },
- "type": {
- "description": "The type of the link. For example, in Hash Joins this could be used to\ndistinguish between the build child and the probe child, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.",
- "type": "string"
- }
- },
- "id": "ChildLink",
- "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
- "type": "object"
- },
- "CloudAuditOptions": {
- "properties": {},
- "id": "CloudAuditOptions",
- "description": "Write a Cloud Audit log",
- "type": "object"
- },
- "Delete": {
- "description": "Arguments to delete operations.",
- "type": "object",
- "properties": {
- "table": {
- "description": "Required. The table whose rows will be deleted.",
- "type": "string"
- },
- "keySet": {
- "$ref": "KeySet",
- "description": "Required. The primary keys of the rows within table to delete."
- }
- },
- "id": "Delete"
- },
- "CommitRequest": {
- "description": "The request for Commit.",
- "type": "object",
- "properties": {
- "singleUseTransaction": {
- "$ref": "TransactionOptions",
- "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead."
- },
- "mutations": {
- "description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",
- "type": "array",
- "items": {
- "$ref": "Mutation"
- }
- },
- "transactionId": {
- "description": "Commit a previously-started transaction.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "CommitRequest"
- },
- "BeginTransactionRequest": {
- "description": "The request for BeginTransaction.",
- "type": "object",
- "properties": {
- "options": {
- "description": "Required. Options for the new transaction.",
- "$ref": "TransactionOptions"
- }
- },
- "id": "BeginTransactionRequest"
- },
- "ListInstanceConfigsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",
- "type": "string"
- },
- "instanceConfigs": {
- "description": "The list of requested instance configurations.",
- "type": "array",
- "items": {
- "$ref": "InstanceConfig"
- }
- }
- },
- "id": "ListInstanceConfigsResponse",
- "description": "The response for ListInstanceConfigs.",
- "type": "object"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "GetIamPolicyRequest": {
- "properties": {},
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object"
- },
- "CreateDatabaseMetadata": {
- "description": "Metadata type for the operation returned by\nCreateDatabase.",
- "type": "object",
- "properties": {
- "database": {
- "description": "The database being created.",
- "type": "string"
- }
- },
- "id": "CreateDatabaseMetadata"
- },
- "Rule": {
- "description": "A rule to be applied in a Policy.",
- "type": "object",
- "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"
- },
- "LogConfig": {
- "description": "Specifies what kind of log the caller must write",
- "type": "object",
- "properties": {
- "cloudAudit": {
- "description": "Cloud audit options.",
- "$ref": "CloudAuditOptions"
- },
- "counter": {
- "description": "Counter options.",
- "$ref": "CounterOptions"
- },
- "dataAccess": {
- "description": "Data access options.",
- "$ref": "DataAccessOptions"
- }
- },
- "id": "LogConfig"
- },
- "Session": {
- "description": "A session in the Cloud Spanner API.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Required. The name of the session.",
- "type": "string"
- }
- },
- "id": "Session"
- },
- "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": {
- "description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "startClosed": {
- "description": "If the start is closed, then the range includes all rows whose\nfirst `len(start_closed)` key columns exactly match `start_closed`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "startOpen": {
- "description": "If the start is open, then the range excludes rows whose first\n`len(start_open)` key columns exactly match `start_open`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "endOpen": {
- "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "id": "KeyRange",
- "description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` clause names two\ncolumns, each `UserEvents` key has two elements; the first is the\n`UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, the following range includes all events for `\"Bob\"` that\noccurred during and after the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end_closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve events before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table:\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_closed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [\"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.",
- "type": "object"
- },
- "ShortRepresentation": {
- "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
- "type": "object",
- "properties": {
- "description": {
- "description": "A string representation of the expression subtree rooted at this node.",
- "type": "string"
- },
- "subqueries": {
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
- },
- "description": "A mapping of (subquery variable name) -\u003e (subquery node id) for cases\nwhere the `description` string of this node references a `SCALAR`\nsubquery contained in the expression subtree rooted at this node. The\nreferenced `SCALAR` subquery may not necessarily be a direct child of\nthis node.",
- "type": "object"
- }
- },
- "id": "ShortRepresentation"
- },
- "InstanceConfig": {
- "properties": {
- "name": {
- "description": "A unique identifier for the instance configuration. Values\nare of the form\n`projects/\u003cproject\u003e/instanceConfigs/a-z*`",
- "type": "string"
- },
- "displayName": {
- "description": "The name of this instance configuration as it appears in UIs.",
- "type": "string"
- }
- },
- "id": "InstanceConfig",
- "description": "A possible configuration for a Cloud Spanner instance. Configurations\ndefine the geographic placement of nodes and their replication.",
- "type": "object"
- },
- "UpdateInstanceRequest": {
- "properties": {
- "instance": {
- "description": "Required. The instance to update, which must always include the instance\nname. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.",
- "$ref": "Instance"
- },
- "fieldMask": {
- "description": "Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.\nThe field mask must always be specified; this prevents any future fields in\n[][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know\nabout them.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateInstanceRequest",
- "description": "The request for UpdateInstance.",
- "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"
- },
- "TransactionOptions": {
- "properties": {
- "readWrite": {
- "description": "Transaction may write.\n\nAuthorization to begin a read-write transaction requires\n`spanner.databases.beginOrRollbackReadWriteTransaction` permission\non the `session` resource.",
- "$ref": "ReadWrite"
- },
- "readOnly": {
- "$ref": "ReadOnly",
- "description": "Transaction will not write.\n\nAuthorization to begin a read-only transaction requires\n`spanner.databases.beginReadOnlyTransaction` permission\non the `session` resource."
- }
- },
- "id": "TransactionOptions",
- "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.\nIf the database ID is a reserved word or if it contains a hyphen, the\ndatabase ID must be enclosed in backticks (`` ` ``).",
- "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"
- }
- }
- },
- "id": "CreateDatabaseRequest",
- "description": "The request for CreateDatabase.",
- "type": "object"
- },
- "CreateInstanceRequest": {
- "description": "The request for CreateInstance.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "CreateInstanceRequest"
- },
- "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",
- "SECURITY_REALM",
- "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.",
- "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).",
- "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"
- },
- "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"
- },
- "ReadOnly": {
- "properties": {
- "strong": {
- "description": "Read at a timestamp where all previously committed transactions\nare visible.",
- "type": "boolean"
- },
- "minReadTimestamp": {
- "description": "Executes all reads at a timestamp \u003e= `min_read_timestamp`.\n\nThis is useful for requesting fresher data than some previous\nread, or data that is fresh enough to observe the effects of some\npreviously committed transaction whose timestamp is known.\n\nNote that this option can only be used in single-use transactions.",
- "format": "google-datetime",
- "type": "string"
- },
- "maxStaleness": {
- "description": "Read data at a timestamp \u003e= `NOW - max_staleness`\nseconds. Guarantees that all writes that have committed more\nthan the specified number of seconds ago are visible. Because\nCloud Spanner chooses the exact timestamp, this mode works even if\nthe client's local clock is substantially skewed from Cloud Spanner\ncommit timestamps.\n\nUseful for reading the freshest data available at a nearby\nreplica, while bounding the possible staleness if the local\nreplica has fallen behind.\n\nNote that this option can only be used in single-use\ntransactions.",
- "format": "google-duration",
- "type": "string"
- },
- "readTimestamp": {
- "description": "Executes all reads at the given timestamp. Unlike other modes,\nreads at a specific timestamp are repeatable; the same read at\nthe same timestamp always returns the same data. If the\ntimestamp is in the future, the read will block until the\nspecified timestamp, modulo the read's deadline.\n\nUseful for large scale consistent reads such as mapreduces, or\nfor coordinating many reads against a consistent snapshot of the\ndata.",
- "format": "google-datetime",
- "type": "string"
- },
- "returnReadTimestamp": {
- "description": "If true, the Cloud Spanner-selected read timestamp is included in\nthe Transaction message that describes the transaction.",
- "type": "boolean"
- },
- "exactStaleness": {
- "description": "Executes all reads at a timestamp that is `exact_staleness`\nold. The timestamp is chosen soon after the read is started.\n\nGuarantees that all writes that have committed more than the\nspecified number of seconds ago are visible. Because Cloud Spanner\nchooses the exact timestamp, this mode works even if the client's\nlocal clock is substantially skewed from Cloud Spanner commit\ntimestamps.\n\nUseful for reading at nearby replicas without the distributed\ntimestamp negotiation overhead of `max_staleness`.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "ReadOnly",
- "description": "Options for read-only transactions.",
- "type": "object"
- },
- "ExecuteSqlRequest": {
- "properties": {
- "sql": {
- "description": "Required. The SQL query string.",
- "type": "string"
- },
- "params": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The SQL query string can contain parameter placeholders. A parameter\nplaceholder consists of `'@'` followed by the parameter\nname. Parameter names consist of any combination of letters,\nnumbers, and underscores.\n\nParameters can appear anywhere that a literal value is expected. The same\nparameter name can be used more than once, for example:\n `\"WHERE id \u003e @msg_id AND id \u003c @msg_id + 100\"`\n\nIt is an error to execute an SQL query with unbound parameters.\n\nParameter values are specified using `params`, which is a JSON\nobject whose keys are parameter names, and whose values are the\ncorresponding parameter values.",
- "type": "object"
- },
- "queryMode": {
- "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."
- ]
- },
- "transaction": {
- "$ref": "TransactionSelector",
- "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
- },
- "resumeToken": {
- "description": "If this request is resuming a previously interrupted SQL query\nexecution, `resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the new SQL query execution to resume where the last one left\noff. The rest of the request parameters must exactly match the\nrequest that yielded this token.",
- "format": "byte",
- "type": "string"
- },
- "paramTypes": {
- "additionalProperties": {
- "$ref": "Type"
- },
- "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.",
- "type": "object"
- }
- },
- "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": {
- "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",
- "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"
- }
- },
- "id": "Policy"
- },
- "ReadRequest": {
- "properties": {
- "limit": {
- "description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.",
- "format": "int64",
- "type": "string"
- },
- "index": {
- "description": "If non-empty, the name of an index on table. This index is\nused instead of the table primary key when interpreting key_set\nand sorting result rows. See key_set for further information.",
- "type": "string"
- },
- "keySet": {
- "$ref": "KeySet",
- "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the\nprimary keys of the rows in table to be yielded, unless index\nis present. If index is present, then key_set instead names\nindex keys in index.\n\nRows are yielded in table primary key order (if index is empty)\nor index key order (if index is non-empty).\n\nIt is not an error for the `key_set` to name rows that do not\nexist in the database. Read yields nothing for nonexistent rows."
- },
- "columns": {
- "description": "The columns of table to be returned for each row matching\nthis request.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "transaction": {
- "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.",
- "format": "byte",
- "type": "string"
- },
- "table": {
- "description": "Required. The name of the table in the database to be read.",
- "type": "string"
- }
- },
- "id": "ReadRequest",
- "description": "The request for Read and\nStreamingRead.",
- "type": "object"
- },
- "Write": {
- "description": "Arguments to insert, update, insert_or_update, and\nreplace operations.",
- "type": "object",
- "properties": {
- "table": {
- "description": "Required. The table whose rows will be written.",
- "type": "string"
- },
- "columns": {
- "description": "The names of the columns in table to be written.\n\nThe list of columns must contain enough columns to allow\nCloud Spanner to derive values for all primary key columns in the\nrow(s) to be modified.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "values": {
- "description": "The values to be written. `values` can contain more than one\nlist of values. If it does, then multiple rows are written, one\nfor each entry in `values`. Each list in `values` must have\nexactly as many entries as there are entries in columns\nabove. Sending multiple lists is equivalent to sending multiple\n`Mutation`s, each containing one `values` entry and repeating\ntable and columns. Individual values in each list are\nencoded as described here.",
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- }
- },
- "id": "Write"
- },
- "DataAccessOptions": {
- "properties": {},
- "id": "DataAccessOptions",
- "description": "Write a Data Access (Gin) log",
- "type": "object"
- },
- "ReadWrite": {
- "properties": {},
- "id": "ReadWrite",
- "description": "Options for read-write transactions.",
+ "id": "ListDatabasesResponse",
+ "description": "The response for ListDatabases.",
"type": "object"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"canonicalName": "Spanner",
"auth": {
"oauth2": {
@@ -1445,16 +1436,13 @@
"instanceConfigs": {
"methods": {
"list": {
+ "httpMethod": "GET",
"response": {
"$ref": "ListInstanceConfigsResponse"
},
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
@@ -1469,132 +1457,50 @@
"location": "query"
},
"pageSize": {
+ "location": "query",
"description": "Number of instance configurations to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/instanceConfigs",
- "path": "v1/{+parent}/instanceConfigs",
"id": "spanner.projects.instanceConfigs.list",
+ "path": "v1/{+parent}/instanceConfigs",
"description": "Lists the supported instance configurations for a given project."
},
"get": {
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instanceConfigs.get",
"description": "Gets information about a particular instance configuration.",
- "httpMethod": "GET",
"response": {
"$ref": "InstanceConfig"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$",
- "location": "path",
"description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/\u003cproject\u003e/instanceConfigs/\u003cconfig\u003e`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}",
- "id": "spanner.projects.instanceConfigs.get",
- "path": "v1/{+name}"
+ "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}"
}
}
},
"instances": {
"methods": {
- "getIamPolicy": {
- "id": "spanner.projects.instances.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy"
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
- },
- "get": {
- "response": {
- "$ref": "Instance"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "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}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.get",
- "description": "Gets information about a particular instance."
- },
"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"
},
@@ -1616,11 +1522,13 @@
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
- "id": "spanner.projects.instances.testIamPermissions"
+ "id": "spanner.projects.instances.testIamPermissions",
+ "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
},
"delete": {
- "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.",
"response": {
"$ref": "Empty"
@@ -1641,7 +1549,9 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.delete"
},
"list": {
"httpMethod": "GET",
@@ -1651,9 +1561,6 @@
"parameterOrder": [
"parent"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"pageToken": {
"description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
@@ -1661,30 +1568,37 @@
"location": "query"
},
"pageSize": {
+ "location": "query",
"description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
"description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
},
"filter": {
- "location": "query",
"description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * name\n * display_name\n * labels.key where key is the name of a label\n\nSome examples of using filters are:\n\n * name:* --\u003e The instance has a name.\n * name:Howl --\u003e The instance's name contains the string \"howl\".\n * name:HOWL --\u003e Equivalent to above.\n * NAME:howl --\u003e Equivalent to above.\n * labels.env:* --\u003e The instance has the label \"env\".\n * labels.env:dev --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * name:howl labels.env:dev --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".",
- "type": "string"
+ "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",
"description": "Lists all instances in the given project."
},
"create": {
+ "description": "Creates an instance and begins preparing it to begin serving. The\nreturned long-running operation\ncan be used to track the progress of preparing the new\ninstance. The instance name is assigned by the caller. If the\nnamed instance already exists, `CreateInstance` returns\n`ALREADY_EXISTS`.\n\nImmediately upon completion of this request:\n\n * The instance is readable via the API, with all requested attributes\n but no allocated resources. Its state is `CREATING`.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation renders the instance immediately unreadable\n via the API.\n * The instance can be deleted.\n * All other attempts to modify the instance are rejected.\n\nUpon completion of the returned operation:\n\n * Billing for all successfully-allocated resources begins (some types\n may have lower than the requested levels).\n * Databases can be created in the instance.\n * The instance's allocated resource levels are readable via the API.\n * The instance's state becomes `READY`.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track creation of the instance. The\nmetadata field type is\nCreateInstanceMetadata.\nThe response field type is\nInstance, if successful.",
+ "request": {
+ "$ref": "CreateInstanceRequest"
+ },
"response": {
"$ref": "Operation"
},
@@ -1692,27 +1606,55 @@
"parent"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
"description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/\u003cproject\u003e`.",
"required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances",
+ "path": "v1/{+parent}/instances",
+ "id": "spanner.projects.instances.create"
+ },
+ "setIamPolicy": {
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "spanner.projects.instances.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "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",
- "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."
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy"
},
- "setIamPolicy": {
+ "getIamPolicy": {
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -1722,7 +1664,7 @@
},
"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.",
+ "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/[^/]+$",
@@ -1732,138 +1674,75 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy",
- "id": "spanner.projects.instances.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy",
+ "id": "spanner.projects.instances.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
+ },
+ "get": {
+ "response": {
+ "$ref": "Instance"
},
- "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource."
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.get",
+ "description": "Gets information about a particular instance."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path",
+ "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "id": "spanner.projects.instances.patch",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "UpdateInstanceRequest"
+ },
+ "description": "Updates an instance, and begins allocating or releasing resources\nas requested. The returned long-running\noperation can be used to track the\nprogress of updating the instance. If the named instance does not\nexist, returns `NOT_FOUND`.\n\nImmediately upon completion of this request:\n\n * For resource types for which a decrease in the instance's allocation\n has been requested, billing is based on the newly-requested level.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation sets its metadata's\n cancel_time, and begins\n restoring resources to their pre-request values. The operation\n is guaranteed to succeed at undoing all resource changes,\n after which point it terminates with a `CANCELLED` status.\n * All other attempts to modify the instance are rejected.\n * Reading the instance via the API continues to give the pre-request\n resource levels.\n\nUpon completion of the returned operation:\n\n * Billing begins for all successfully-allocated resources (some types\n may have lower than the requested levels).\n * All newly-reserved resources are available for serving the instance's\n tables.\n * The instance's new resource levels are readable via the API.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track the instance modification. The\nmetadata field type is\nUpdateInstanceMetadata.\nThe response field type is\nInstance, if successful.\n\nAuthorization requires `spanner.instances.update` permission on\nresource name."
}
},
"resources": {
"databases": {
"methods": {
- "create": {
- "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"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The name of the instance that will serve the new database.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases"
- },
- "setIamPolicy": {
- "path": "v1/{+resource}:setIamPolicy",
- "id": "spanner.projects.instances.databases.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy"
- },
- "getIamPolicy": {
- "id": "spanner.projects.instances.databases.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "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}",
- "id": "spanner.projects.instances.databases.get",
- "path": "v1/{+name}",
- "description": "Gets the state of a Cloud Spanner database."
- },
"dropDatabase": {
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"database"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"database": {
"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
@@ -1873,6 +1752,9 @@
"type": "string"
}
},
+ "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",
@@ -1888,11 +1770,11 @@
},
"parameters": {
"database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
"description": "Required. The database to update.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -1907,13 +1789,13 @@
"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"
},
+ "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.",
@@ -1927,39 +1809,41 @@
"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",
+ "id": "spanner.projects.instances.databases.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": {
- "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.",
+ "httpMethod": "GET",
"response": {
"$ref": "GetDatabaseDdlResponse"
},
"parameterOrder": [
"database"
],
- "httpMethod": "GET",
+ "parameters": {
+ "database": {
+ "description": "Required. The database whose schema we wish to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "Required. The database whose schema we wish to get.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl"
+ "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": {
+ "path": "v1/{+parent}/databases",
+ "id": "spanner.projects.instances.databases.list",
"description": "Lists Cloud Spanner databases.",
"response": {
"$ref": "ListDatabasesResponse"
@@ -1969,21 +1853,99 @@
],
"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": {
+ "location": "query",
"description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.",
"format": "int32",
- "type": "integer",
- "location": "query"
- },
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases"
+ },
+ "setIamPolicy": {
+ "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 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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "spanner.projects.instances.databases.setIamPolicy",
+ "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "create": {
+ "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 instance whose databases should be listed.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
+ "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",
+ "id": "spanner.projects.instances.databases.create",
+ "path": "v1/{+parent}/databases"
+ },
+ "getIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being 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"
}
@@ -1991,23 +1953,51 @@
"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"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy",
+ "id": "spanner.projects.instances.databases.getIamPolicy",
+ "path": "v1/{+resource}: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."
+ },
+ "get": {
+ "response": {
+ "$ref": "Database"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "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."
}
},
"resources": {
"operations": {
"methods": {
"cancel": {
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "response": {
+ "$ref": "Empty"
+ },
"parameterOrder": [
"name"
],
"httpMethod": "POST",
- "response": {
- "$ref": "Empty"
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -2022,34 +2012,36 @@
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel",
"path": "v1/{+name}:cancel",
- "id": "spanner.projects.instances.databases.operations.cancel"
+ "id": "spanner.projects.instances.databases.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
},
"delete": {
- "httpMethod": "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"
],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
"id": "spanner.projects.instances.databases.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`."
+ "path": "v1/{+name}"
},
"list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
"response": {
"$ref": "ListOperationsResponse"
},
@@ -2057,6 +2049,9 @@
"name"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$",
@@ -2082,25 +2077,19 @@
"type": "string"
}
},
- "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`."
+ "id": "spanner.projects.instances.databases.operations.list"
},
"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"
},
- "httpMethod": "GET",
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -2113,132 +2102,51 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.operations.get"
}
}
},
"sessions": {
"methods": {
- "rollback": {
- "description": "Rolls back a transaction, releasing any locks it holds. It is a good\nidea to call this for any transaction that includes one or more\nRead or ExecuteSql requests and\nultimately decides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the transaction, the\ntransaction was already aborted, or the transaction is not\nfound. `Rollback` never returns `ABORTED`.",
- "request": {
- "$ref": "RollbackRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the transaction to roll back is running.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback",
- "path": "v1/{+session}:rollback",
- "id": "spanner.projects.instances.databases.sessions.rollback"
- },
- "streamingRead": {
- "response": {
- "$ref": "PartialResultSet"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the read should be performed.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead",
- "path": "v1/{+session}:streamingRead",
- "id": "spanner.projects.instances.databases.sessions.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": {
- "description": "Creates a new session. A session can be used to perform\ntransactions that read and/or modify data in a Cloud Spanner database.\nSessions are meant to be reused for many consecutive\ntransactions.\n\nSessions can only execute one transaction at a time. To execute\nmultiple concurrent read-write/write-only transactions, create\nmultiple sessions. Note that standalone reads and queries use a\ntransaction internally, and count toward the one transaction\nlimit.\n\nCloud Spanner limits the number of sessions that can exist at any given\ntime; thus, it is a good idea to delete idle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can delete sessions for which no\noperations are sent for more than an hour. If a session is deleted,\nrequests to it return `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.",
- "response": {
- "$ref": "Session"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "Required. The database in which the new session is created.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions",
- "path": "v1/{+database}/sessions",
- "id": "spanner.projects.instances.databases.sessions.create"
- },
"read": {
+ "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"
},
- "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
"response": {
"$ref": "ResultSet"
},
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the read should be performed.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "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}:read",
- "path": "v1/{+session}:read",
- "id": "spanner.projects.instances.databases.sessions.read"
+ "id": "spanner.projects.instances.databases.sessions.read",
+ "path": "v1/{+session}: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.",
+ "httpMethod": "GET",
"response": {
"$ref": "Session"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -2251,35 +2159,37 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
+ "id": "spanner.projects.instances.databases.sessions.get",
+ "path": "v1/{+name}"
},
"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"
},
- "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session.",
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
"response": {
"$ref": "CommitResponse"
},
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the transaction to be committed is running.",
- "required": true,
- "type": "string"
- }
- },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit"
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the transaction to be committed is running.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit",
+ "path": "v1/{+session}:commit",
+ "id": "spanner.projects.instances.databases.sessions.commit"
},
"executeStreamingSql": {
"response": {
@@ -2310,20 +2220,21 @@
}
},
"delete": {
- "parameterOrder": [
- "name"
- ],
+ "description": "Ends a session, releasing server resources associated with it.",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
- "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
"description": "Required. The name of the session to delete.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -2331,8 +2242,7 @@
],
"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."
+ "path": "v1/{+name}"
},
"beginTransaction": {
"id": "spanner.projects.instances.databases.sessions.beginTransaction",
@@ -2363,12 +2273,6 @@
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction"
},
"executeSql": {
- "id": "spanner.projects.instances.databases.sessions.executeSql",
- "path": "v1/{+session}:executeSql",
- "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",
- "request": {
- "$ref": "ExecuteSqlRequest"
- },
"httpMethod": "POST",
"parameterOrder": [
"session"
@@ -2376,9 +2280,6 @@
"response": {
"$ref": "ResultSet"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"session": {
"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
@@ -2388,7 +2289,97 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}: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."
+ },
+ "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`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "session": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The session in which the transaction to roll back is running.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback",
+ "path": "v1/{+session}:rollback",
+ "id": "spanner.projects.instances.databases.sessions.rollback"
+ },
+ "streamingRead": {
+ "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB.",
+ "request": {
+ "$ref": "ReadRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "PartialResultSet"
+ },
+ "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",
+ "id": "spanner.projects.instances.databases.sessions.streamingRead",
+ "path": "v1/{+session}:streamingRead"
+ },
+ "create": {
+ "id": "spanner.projects.instances.databases.sessions.create",
+ "path": "v1/{+database}/sessions",
+ "description": "Creates a new session. A session can be used to perform\ntransactions that read and/or modify data in a Cloud Spanner database.\nSessions are meant to be reused for many consecutive\ntransactions.\n\nSessions can only execute one transaction at a time. To execute\nmultiple concurrent read-write/write-only transactions, create\nmultiple sessions. Note that standalone reads and queries use a\ntransaction internally, and count toward the one transaction\nlimit.\n\nCloud Spanner limits the number of sessions that can exist at any given\ntime; thus, it is a good idea to delete idle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can delete sessions for which no\noperations are sent for more than an hour. If a session is deleted,\nrequests to it return `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Session"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "parameters": {
+ "database": {
+ "description": "Required. The database in which the new session is created.",
+ "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}/sessions"
}
}
}
@@ -2404,27 +2395,24 @@
"parameterOrder": [
"name"
],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel",
"id": "spanner.projects.instances.operations.cancel",
"path": "v1/{+name}:cancel",
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
},
"delete": {
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
"response": {
"$ref": "Empty"
},
@@ -2444,10 +2432,12 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.operations.delete",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
},
"list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
"httpMethod": "GET",
"response": {
"$ref": "ListOperationsResponse"
@@ -2455,9 +2445,6 @@
"parameterOrder": [
"name"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"filter": {
"description": "The standard list filter.",
@@ -2465,16 +2452,16 @@
"location": "query"
},
"name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations$",
+ "location": "path",
"description": "The name of the operation collection.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/operations$",
- "location": "path"
+ "type": "string"
},
"pageToken": {
- "location": "query",
"description": "The standard list page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -2483,21 +2470,22 @@
"type": "integer"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations",
"id": "spanner.projects.instances.operations.list",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding 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.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"
],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -2510,7 +2498,10 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.operations.get",
+ "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."
}
}
}
@@ -2520,36 +2511,20 @@
}
},
"parameters": {
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -2557,34 +2532,39 @@
"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\").",
+ "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.",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "uploadType": {
- "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"
+ },
+ "callback": {
+ "description": "JSONP",
"type": "string",
"location": "query"
},
@@ -2601,10 +2581,30 @@
"description": "V1 error format.",
"type": "string"
},
- "callback": {
+ "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": "JSONP",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string"
}
- }
+ },
+ "version": "v1",
+ "baseUrl": "https://spanner.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "spanner:v1",
+ "revision": "20170425",
+ "documentationLink": "https://cloud.google.com/spanner/"
}
diff --git a/speech/v1/speech-api.json b/speech/v1/speech-api.json
index ecc5211..2dd6051 100644
--- a/speech/v1/speech-api.json
+++ b/speech/v1/speech-api.json
@@ -1,170 +1,5 @@
{
- "discoveryVersion": "v1",
- "version_module": "True",
"schemas": {
- "RecognizeRequest": {
- "description": "The top-level message sent by the client for the `Recognize` method.",
- "type": "object",
- "properties": {
- "config": {
- "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.",
- "$ref": "RecognitionConfig"
- },
- "audio": {
- "description": "*Required* The audio data to be recognized.",
- "$ref": "RecognitionAudio"
- }
- },
- "id": "RecognizeRequest"
- },
- "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": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "SpeechContext": {
- "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
- "type": "object",
- "properties": {
- "phrases": {
- "description": "*Optional* A list of strings containing words and phrases \"hints\" so that\nthe speech recognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for example, if\nspecific commands are typically spoken by the user. This can also be used\nto add additional words to the vocabulary of the recognizer. See\n[usage limits](https://cloud.google.com/speech/limits#content).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "SpeechContext"
- },
- "SpeechRecognitionResult": {
- "description": "A speech recognition result corresponding to a portion of the audio.",
- "type": "object",
- "properties": {
- "alternatives": {
- "description": "*Output-only* May contain one or more recognition hypotheses (up to the\nmaximum specified in `max_alternatives`).\nThese alternatives are ordered in terms of accuracy, with the first/top\nalternative being the most probable, as ranked by the recognizer.",
- "type": "array",
- "items": {
- "$ref": "SpeechRecognitionAlternative"
- }
- }
- },
- "id": "SpeechRecognitionResult"
- },
- "RecognitionAudio": {
- "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
- "type": "object",
- "properties": {
- "content": {
- "description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
- "format": "byte",
- "type": "string"
- },
- "uri": {
- "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
- "type": "string"
- }
- },
- "id": "RecognitionAudio"
- },
- "LongRunningRecognizeRequest": {
- "description": "The top-level message sent by the client for the `LongRunningRecognize`\nmethod.",
- "type": "object",
- "properties": {
- "config": {
- "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.",
- "$ref": "RecognitionConfig"
- },
- "audio": {
- "description": "*Required* The audio data to be recognized.",
- "$ref": "RecognitionAudio"
- }
- },
- "id": "LongRunningRecognizeRequest"
- },
- "RecognizeResponse": {
- "description": "The only message returned to the client by the `Recognize` method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
- "type": "object",
- "properties": {
- "results": {
- "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
- "type": "array",
- "items": {
- "$ref": "SpeechRecognitionResult"
- }
- }
- },
- "id": "RecognizeResponse"
- },
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- }
- },
- "id": "Operation"
- },
"RecognitionConfig": {
"description": "Provides information to the recognizer that specifies how to process the\nrequest.",
"type": "object",
@@ -222,18 +57,9 @@
"id": "RecognitionConfig"
},
"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.",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
"type": "array",
@@ -244,6 +70,15 @@
},
"type": "object"
}
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
"id": "Status"
@@ -253,6 +88,169 @@
"type": "object",
"properties": {},
"id": "Empty"
+ },
+ "RecognizeRequest": {
+ "description": "The top-level message sent by the client for the `Recognize` method.",
+ "type": "object",
+ "properties": {
+ "config": {
+ "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.",
+ "$ref": "RecognitionConfig"
+ },
+ "audio": {
+ "$ref": "RecognitionAudio",
+ "description": "*Required* The audio data to be recognized."
+ }
+ },
+ "id": "RecognizeRequest"
+ },
+ "SpeechContext": {
+ "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
+ "type": "object",
+ "properties": {
+ "phrases": {
+ "description": "*Optional* A list of strings containing words and phrases \"hints\" so that\nthe speech recognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for example, if\nspecific commands are typically spoken by the user. This can also be used\nto add additional words to the vocabulary of the recognizer. See\n[usage limits](https://cloud.google.com/speech/limits#content).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "SpeechContext"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "SpeechRecognitionAlternative": {
+ "description": "Alternative hypotheses (a.k.a. n-best list).",
+ "type": "object",
+ "properties": {
+ "confidence": {
+ "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
+ "format": "float",
+ "type": "number"
+ },
+ "transcript": {
+ "description": "*Output-only* Transcript text representing the words that the user spoke.",
+ "type": "string"
+ }
+ },
+ "id": "SpeechRecognitionAlternative"
+ },
+ "SpeechRecognitionResult": {
+ "properties": {
+ "alternatives": {
+ "description": "*Output-only* May contain one or more recognition hypotheses (up to the\nmaximum specified in `max_alternatives`).\nThese alternatives are ordered in terms of accuracy, with the first/top\nalternative being the most probable, as ranked by the recognizer.",
+ "type": "array",
+ "items": {
+ "$ref": "SpeechRecognitionAlternative"
+ }
+ }
+ },
+ "id": "SpeechRecognitionResult",
+ "description": "A speech recognition result corresponding to a portion of the audio.",
+ "type": "object"
+ },
+ "RecognitionAudio": {
+ "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "LongRunningRecognizeRequest": {
+ "description": "The top-level message sent by the client for the `LongRunningRecognize`\nmethod.",
+ "type": "object",
+ "properties": {
+ "config": {
+ "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.",
+ "$ref": "RecognitionConfig"
+ },
+ "audio": {
+ "description": "*Required* The audio data to be recognized.",
+ "$ref": "RecognitionAudio"
+ }
+ },
+ "id": "LongRunningRecognizeRequest"
+ },
+ "RecognizeResponse": {
+ "description": "The only message returned to the client by the `Recognize` method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
+ "type": "object",
+ "properties": {
+ "results": {
+ "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
+ "type": "array",
+ "items": {
+ "$ref": "SpeechRecognitionResult"
+ }
+ }
+ },
+ "id": "RecognizeResponse"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ }
+ },
+ "id": "Operation"
}
},
"icons": {
@@ -280,17 +278,19 @@
"operations": {
"methods": {
"cancel": {
+ "path": "v1/operations/{+name}:cancel",
+ "id": "speech.operations.cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
@@ -303,19 +303,16 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/operations/{operationsId}:cancel",
- "id": "speech.operations.cancel",
- "path": "v1/operations/{+name}:cancel"
+ "flatPath": "v1/operations/{operationsId}:cancel"
},
"delete": {
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
@@ -329,58 +326,55 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/operations/{operationsId}",
+ "path": "v1/operations/{+name}",
"id": "speech.operations.delete",
- "path": "v1/operations/{+name}"
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
},
"list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name of the operation's parent resource.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"type": "integer",
"location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "description": "The name of the operation collection.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
}
},
- "flatPath": "v1/operations",
- "path": "v1/operations",
- "id": "speech.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding 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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1/operations",
+ "path": "v1/operations",
+ "id": "speech.operations.list"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"name": {
"location": "path",
@@ -390,40 +384,37 @@
"pattern": "^[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/operations/{operationsId}",
+ "id": "speech.operations.get",
"path": "v1/operations/{+name}",
- "id": "speech.operations.get"
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
}
}
},
"speech": {
"methods": {
"longrunningrecognize": {
+ "description": "Performs asynchronous speech recognition: receive results via the\ngoogle.longrunning.Operations interface. Returns either an\n`Operation.error` or an `Operation.response` which contains\na `LongRunningRecognizeResponse` message.",
"request": {
"$ref": "LongRunningRecognizeRequest"
},
- "description": "Performs asynchronous speech recognition: receive results via the\ngoogle.longrunning.Operations interface. Returns either an\n`Operation.error` or an `Operation.response` which contains\na `LongRunningRecognizeResponse` message.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "Operation"
},
- "parameters": {},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {},
"flatPath": "v1/speech:longrunningrecognize",
- "id": "speech.speech.longrunningrecognize",
- "path": "v1/speech:longrunningrecognize"
+ "path": "v1/speech:longrunningrecognize",
+ "id": "speech.speech.longrunningrecognize"
},
"recognize": {
- "flatPath": "v1/speech:recognize",
- "path": "v1/speech:recognize",
- "id": "speech.speech.recognize",
- "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
- "request": {
- "$ref": "RecognizeRequest"
- },
"response": {
"$ref": "RecognizeResponse"
},
@@ -432,25 +423,35 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {}
+ "parameters": {},
+ "flatPath": "v1/speech:recognize",
+ "path": "v1/speech:recognize",
+ "id": "speech.speech.recognize",
+ "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
+ "request": {
+ "$ref": "RecognizeRequest"
+ }
}
}
}
},
"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"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -459,15 +460,11 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -480,11 +477,7 @@
"json",
"media",
"proto"
- ]
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
+ ],
"type": "string"
},
"key": {
@@ -492,46 +485,53 @@
"type": "string",
"location": "query"
},
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "default": "true",
+ "location": "query"
},
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
}
},
"version": "v1",
"baseUrl": "https://speech.googleapis.com/",
+ "servicePath": "",
"kind": "discovery#restDescription",
"description": "Converts audio to text by applying powerful neural network models.",
- "servicePath": "",
"basePath": "",
- "revision": "20170501",
"id": "speech:v1",
- "documentationLink": "https://cloud.google.com/speech/"
+ "documentationLink": "https://cloud.google.com/speech/",
+ "revision": "20170530",
+ "discoveryVersion": "v1",
+ "version_module": "True"
}
diff --git a/speech/v1/speech-gen.go b/speech/v1/speech-gen.go
index 4e6b7f7..79ca0b4 100644
--- a/speech/v1/speech-gen.go
+++ b/speech/v1/speech-gen.go
@@ -671,7 +671,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -704,7 +704,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
@@ -1203,9 +1203,18 @@
// server doesn't support this method, it returns
// `UNIMPLEMENTED`.
//
-// NOTE: the `name` binding below allows API services to override the
+// NOTE: the `name` binding allows API services to override the
// binding
// to use different resource name schemes, such as `users/*/operations`.
+// To
+// override the binding, API services can add a binding such
+// as
+// "/v1/{name=users/*}/operations" to their service configuration.
+// For backwards compatibility, the default name includes the
+// operations
+// collection id, however overriding users must ensure the name
+// binding
+// is the parent resource, without the operations collection id.
func (r *OperationsService) List() *OperationsListCall {
c := &OperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
return c
@@ -1218,8 +1227,8 @@
return c
}
-// Name sets the optional parameter "name": The name of the operation
-// collection.
+// Name sets the optional parameter "name": The name of the operation's
+// parent resource.
func (c *OperationsListCall) Name(name string) *OperationsListCall {
c.urlParams_.Set("name", name)
return c
@@ -1330,7 +1339,7 @@
}
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`.",
+ // "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
// "flatPath": "v1/operations",
// "httpMethod": "GET",
// "id": "speech.operations.list",
@@ -1342,7 +1351,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "query",
// "type": "string"
// },
diff --git a/speech/v1beta1/speech-api.json b/speech/v1beta1/speech-api.json
index 7dd45fd..4a12b85 100644
--- a/speech/v1beta1/speech-api.json
+++ b/speech/v1beta1/speech-api.json
@@ -1,8 +1,8 @@
{
+ "discoveryVersion": "v1",
+ "version_module": "True",
"schemas": {
"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.",
@@ -19,10 +19,12 @@
"type": "string"
},
"speechContext": {
- "$ref": "SpeechContext",
- "description": "*Optional* A means to provide context to assist the speech recognition."
+ "description": "*Optional* A means to provide context to assist the speech recognition.",
+ "$ref": "SpeechContext"
},
"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`.",
@@ -38,16 +40,16 @@
"MULAW",
"AMR",
"AMR_WB"
- ],
- "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
- "type": "string"
+ ]
},
"profanityFilter": {
"description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
"type": "boolean"
}
},
- "id": "RecognitionConfig"
+ "id": "RecognitionConfig",
+ "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
+ "type": "object"
},
"SyncRecognizeRequest": {
"description": "The top-level message sent by the client for the `SyncRecognize` method.",
@@ -58,14 +60,28 @@
"$ref": "RecognitionConfig"
},
"audio": {
- "$ref": "RecognitionAudio",
- "description": "*Required* The audio data to be recognized."
+ "description": "*Required* The audio data to be recognized.",
+ "$ref": "RecognitionAudio"
}
},
"id": "SyncRecognizeRequest"
},
+ "SyncRecognizeResponse": {
+ "properties": {
+ "results": {
+ "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
+ "type": "array",
+ "items": {
+ "$ref": "SpeechRecognitionResult"
+ }
+ }
+ },
+ "id": "SyncRecognizeResponse",
+ "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
+ "type": "object"
+ },
"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.",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"code": {
@@ -91,29 +107,13 @@
},
"id": "Status"
},
- "SyncRecognizeResponse": {
- "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
- "type": "object",
- "properties": {
- "results": {
- "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
- "type": "array",
- "items": {
- "$ref": "SpeechRecognitionResult"
- }
- }
- },
- "id": "SyncRecognizeResponse"
- },
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
"properties": {},
- "id": "Empty"
+ "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"
},
"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.",
@@ -125,7 +125,9 @@
"type": "string"
}
},
- "id": "SpeechRecognitionAlternative"
+ "id": "SpeechRecognitionAlternative",
+ "description": "Alternative hypotheses (a.k.a. n-best list).",
+ "type": "object"
},
"SpeechContext": {
"description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
@@ -145,23 +147,21 @@
"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"
},
"SpeechRecognitionResult": {
- "description": "A speech recognition result corresponding to a portion of the audio.",
- "type": "object",
"properties": {
"alternatives": {
"description": "*Output-only* May contain one or more recognition hypotheses (up to the\nmaximum specified in `max_alternatives`).",
@@ -171,7 +171,9 @@
}
}
},
- "id": "SpeechRecognitionResult"
+ "id": "SpeechRecognitionResult",
+ "description": "A speech recognition result corresponding to a portion of the audio.",
+ "type": "object"
},
"AsyncRecognizeRequest": {
"description": "The top-level message sent by the client for the `AsyncRecognize` method.",
@@ -182,8 +184,8 @@
"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"
@@ -192,33 +194,31 @@
"description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
"type": "object",
"properties": {
+ "uri": {
+ "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
+ "type": "string"
+ },
"content": {
"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"
},
"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`.",
@@ -237,14 +237,16 @@
"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"
}
},
+ "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
"canonicalName": "Speech",
"auth": {
"oauth2": {
@@ -265,10 +267,6 @@
"operations": {
"methods": {
"list": {
- "flatPath": "v1beta1/operations",
- "path": "v1beta1/operations",
- "id": "speech.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
"response": {
"$ref": "ListOperationsResponse"
},
@@ -285,7 +283,7 @@
},
"name": {
"location": "query",
- "description": "The name of the operation collection.",
+ "description": "The name of the operation's parent resource.",
"type": "string"
},
"pageToken": {
@@ -299,82 +297,86 @@
"format": "int32",
"type": "integer"
}
- }
+ },
+ "flatPath": "v1beta1/operations",
+ "path": "v1beta1/operations",
+ "id": "speech.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
},
"get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/operations/{operationsId}",
+ "path": "v1beta1/operations/{+name}",
+ "id": "speech.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ },
+ "cancel": {
+ "path": "v1beta1/operations/{+name}:cancel",
+ "id": "speech.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/operations/{operationsId}:cancel"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"location": "path",
- "description": "The name of the operation resource.",
+ "description": "The name of the operation resource to be deleted.",
"required": true,
"type": "string",
"pattern": "^[^/]+$"
}
},
"flatPath": "v1beta1/operations/{operationsId}",
- "id": "speech.operations.get",
- "path": "v1beta1/operations/{+name}"
- },
- "cancel": {
- "flatPath": "v1beta1/operations/{operationsId}:cancel",
- "id": "speech.operations.cancel",
- "path": "v1beta1/operations/{+name}:cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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": "^[^/]+$",
- "location": "path"
- }
- }
- },
- "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`.",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/operations/{operationsId}",
+ "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`."
}
}
},
@@ -385,52 +387,70 @@
"request": {
"$ref": "AsyncRecognizeRequest"
},
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Operation"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
"flatPath": "v1beta1/speech:asyncrecognize",
- "path": "v1beta1/speech:asyncrecognize",
- "id": "speech.speech.asyncrecognize"
+ "id": "speech.speech.asyncrecognize",
+ "path": "v1beta1/speech:asyncrecognize"
},
"syncrecognize": {
+ "id": "speech.speech.syncrecognize",
+ "path": "v1beta1/speech:syncrecognize",
+ "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
+ "request": {
+ "$ref": "SyncRecognizeRequest"
+ },
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "SyncRecognizeResponse"
},
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/speech:syncrecognize",
- "id": "speech.speech.syncrecognize",
- "path": "v1beta1/speech:syncrecognize",
- "request": {
- "$ref": "SyncRecognizeRequest"
- },
- "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed."
+ "parameters": {},
+ "flatPath": "v1beta1/speech:syncrecognize"
}
}
}
},
"parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -439,16 +459,10 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
+ ]
},
"alt": {
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -461,8 +475,7 @@
"json",
"media",
"proto"
- ],
- "type": "string"
+ ]
},
"access_token": {
"location": "query",
@@ -470,24 +483,19 @@
"type": "string"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
+ "default": "true",
"location": "query"
},
"bearer_token": {
@@ -495,16 +503,10 @@
"description": "OAuth bearer token.",
"type": "string"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
}
},
"version": "v1beta1",
@@ -513,9 +515,7 @@
"description": "Converts audio to text by applying powerful neural network models.",
"kind": "discovery#restDescription",
"basePath": "",
- "revision": "20170501",
- "id": "speech:v1beta1",
"documentationLink": "https://cloud.google.com/speech/",
- "discoveryVersion": "v1",
- "version_module": "True"
+ "revision": "20170530",
+ "id": "speech:v1beta1"
}
diff --git a/speech/v1beta1/speech-gen.go b/speech/v1beta1/speech-gen.go
index 6a4582a..c28dec1 100644
--- a/speech/v1beta1/speech-gen.go
+++ b/speech/v1beta1/speech-gen.go
@@ -565,7 +565,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -598,7 +598,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
@@ -1159,9 +1159,18 @@
// server doesn't support this method, it returns
// `UNIMPLEMENTED`.
//
-// NOTE: the `name` binding below allows API services to override the
+// NOTE: the `name` binding allows API services to override the
// binding
// to use different resource name schemes, such as `users/*/operations`.
+// To
+// override the binding, API services can add a binding such
+// as
+// "/v1/{name=users/*}/operations" to their service configuration.
+// For backwards compatibility, the default name includes the
+// operations
+// collection id, however overriding users must ensure the name
+// binding
+// is the parent resource, without the operations collection id.
func (r *OperationsService) List() *OperationsListCall {
c := &OperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
return c
@@ -1174,8 +1183,8 @@
return c
}
-// Name sets the optional parameter "name": The name of the operation
-// collection.
+// Name sets the optional parameter "name": The name of the operation's
+// parent resource.
func (c *OperationsListCall) Name(name string) *OperationsListCall {
c.urlParams_.Set("name", name)
return c
@@ -1286,7 +1295,7 @@
}
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`.",
+ // "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
// "flatPath": "v1beta1/operations",
// "httpMethod": "GET",
// "id": "speech.operations.list",
@@ -1298,7 +1307,7 @@
// "type": "string"
// },
// "name": {
- // "description": "The name of the operation collection.",
+ // "description": "The name of the operation's parent resource.",
// "location": "query",
// "type": "string"
// },
diff --git a/sqladmin/v1beta4/sqladmin-api.json b/sqladmin/v1beta4/sqladmin-api.json
index 5cdb9d7..6c11647 100644
--- a/sqladmin/v1beta4/sqladmin-api.json
+++ b/sqladmin/v1beta4/sqladmin-api.json
@@ -1,12 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/HY0tRuJ-vWPnM8lK2hqBBFUYsUk\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/epSKU8P8WOZtpaH2MUyjoX5-EVg\"",
"discoveryVersion": "v1",
"id": "sqladmin:v1beta4",
"name": "sqladmin",
"canonicalName": "SQL Admin",
"version": "v1beta4",
- "revision": "20170217",
+ "revision": "20170525",
"title": "Cloud SQL Administration API",
"description": "Creates and configures Cloud SQL instances, which provide fully-managed MySQL databases.",
"ownerDomain": "google.com",
@@ -647,6 +647,10 @@
"type": "string",
"description": "The file type for the specified uri.\nSQL: The file contains SQL statements.\nCSV: The file contains CSV data."
},
+ "importUser": {
+ "type": "string",
+ "description": "The PostgreSQL user to use for this import operation. Defaults to cloudsqlsuperuser. Does not apply to MySQL instances."
+ },
"kind": {
"type": "string",
"description": "This is always sql#importContext.",
@@ -789,21 +793,6 @@
}
}
},
- "Labels": {
- "id": "Labels",
- "type": "object",
- "description": "User defined labels for Cloud SQL instances.",
- "properties": {
- "key": {
- "type": "string",
- "description": "The key of the label."
- },
- "value": {
- "type": "string",
- "description": "The value of the label."
- }
- }
- },
"LocationPreference": {
"id": "LocationPreference",
"type": "object",
@@ -977,8 +966,7 @@
"description": "Name of the database instance related to this operation."
},
"targetLink": {
- "type": "string",
- "description": "The URI of the instance related to the operation."
+ "type": "string"
},
"targetProject": {
"type": "string",
@@ -1156,10 +1144,11 @@
"default": "sql#settings"
},
"labels": {
- "type": "array",
- "description": "User defined labels.",
- "items": {
- "$ref": "Labels"
+ "type": "object",
+ "description": "User-provided labels, represented as a dictionary where each label is a single key value pair.",
+ "additionalProperties": {
+ "type": "string",
+ "description": "An individual label entry, composed of a key and a value."
}
},
"locationPreference": {
@@ -1190,7 +1179,7 @@
},
"storageAutoResize": {
"type": "boolean",
- "description": "Configuration to increase storage size automatically. The default value is false. Applies only to Second Generation instances."
+ "description": "Configuration to increase storage size automatically. The default value is true. Applies only to Second Generation instances."
},
"storageAutoResizeLimit": {
"type": "string",
@@ -2106,7 +2095,7 @@
"parameters": {
"filter": {
"type": "string",
- "description": "A filter expression for filtering listed instances.",
+ "description": "An expression for filtering the results of the request, such as by name or label.",
"location": "query"
},
"maxResults": {
diff --git a/sqladmin/v1beta4/sqladmin-gen.go b/sqladmin/v1beta4/sqladmin-gen.go
index 128463c..2eeabbd 100644
--- a/sqladmin/v1beta4/sqladmin-gen.go
+++ b/sqladmin/v1beta4/sqladmin-gen.go
@@ -1005,6 +1005,10 @@
// CSV: The file contains CSV data.
FileType string `json:"fileType,omitempty"`
+ // ImportUser: The PostgreSQL user to use for this import operation.
+ // Defaults to cloudsqlsuperuser. Does not apply to MySQL instances.
+ ImportUser string `json:"importUser,omitempty"`
+
// Kind: This is always sql#importContext.
Kind string `json:"kind,omitempty"`
@@ -1362,37 +1366,6 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Labels: User defined labels for Cloud SQL instances.
-type Labels struct {
- // Key: The key of the label.
- Key string `json:"key,omitempty"`
-
- // Value: The value of the label.
- Value string `json:"value,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Key") 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. "Key") 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 *Labels) MarshalJSON() ([]byte, error) {
- type noMethod Labels
- raw := noMethod(*s)
- return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
-}
-
// LocationPreference: Preferred location. This specifies where a Cloud
// SQL instance should preferably be located, either in a specific
// Compute Engine zone, or co-located with an App Engine application.
@@ -1627,7 +1600,6 @@
// TargetId: Name of the database instance related to this operation.
TargetId string `json:"targetId,omitempty"`
- // TargetLink: The URI of the instance related to the operation.
TargetLink string `json:"targetLink,omitempty"`
// TargetProject: The project ID of the target instance related to this
@@ -1909,8 +1881,9 @@
// Kind: This is always sql#settings.
Kind string `json:"kind,omitempty"`
- // Labels: User defined labels.
- Labels []*Labels `json:"labels,omitempty"`
+ // Labels: User-provided labels, represented as a dictionary where each
+ // label is a single key value pair.
+ Labels map[string]string `json:"labels,omitempty"`
// LocationPreference: The location preference settings. This allows the
// instance to be located as near as possible to either an App Engine
@@ -1940,7 +1913,7 @@
SettingsVersion int64 `json:"settingsVersion,omitempty,string"`
// StorageAutoResize: Configuration to increase storage size
- // automatically. The default value is false. Applies only to Second
+ // automatically. The default value is true. Applies only to Second
// Generation instances.
StorageAutoResize *bool `json:"storageAutoResize,omitempty"`
@@ -5113,8 +5086,8 @@
return c
}
-// Filter sets the optional parameter "filter": A filter expression for
-// filtering listed instances.
+// Filter sets the optional parameter "filter": An expression for
+// filtering the results of the request, such as by name or label.
func (c *InstancesListCall) Filter(filter string) *InstancesListCall {
c.urlParams_.Set("filter", filter)
return c
@@ -5237,7 +5210,7 @@
// ],
// "parameters": {
// "filter": {
- // "description": "A filter expression for filtering listed instances.",
+ // "description": "An expression for filtering the results of the request, such as by name or label.",
// "location": "query",
// "type": "string"
// },
diff --git a/storage/v1/storage-api.json b/storage/v1/storage-api.json
index 7251a6a..eb1513e 100644
--- a/storage/v1/storage-api.json
+++ b/storage/v1/storage-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/9bnQR_kC7lWpyFxyRiXZLFFekco\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/GRtDpiDRivRW7hDEFVrFuoXBCxk\"",
"discoveryVersion": "v1",
"id": "storage:v1",
"name": "storage",
"version": "v1",
- "revision": "20170329",
+ "revision": "20170510",
"title": "Cloud Storage JSON API",
"description": "Stores and retrieves potentially large, immutable data objects.",
"ownerDomain": "google.com",
@@ -108,6 +108,16 @@
]
}
},
+ "billing": {
+ "type": "object",
+ "description": "The bucket's billing configuration.",
+ "properties": {
+ "requesterPays": {
+ "type": "boolean",
+ "description": "When set to true, bucket is requester pays."
+ }
+ }
+ },
"cors": {
"type": "array",
"description": "The bucket's Cross-Origin Resource Sharing (CORS) configuration.",
@@ -988,7 +998,7 @@
"objectSize": {
"type": "string",
"description": "The total size of the object being copied in bytes. This property is always present in the response.",
- "format": "uint64"
+ "format": "int64"
},
"resource": {
"$ref": "Object",
@@ -1001,7 +1011,7 @@
"totalBytesRewritten": {
"type": "string",
"description": "The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response.",
- "format": "uint64"
+ "format": "int64"
}
}
},
@@ -1061,6 +1071,11 @@
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1089,6 +1104,11 @@
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1114,6 +1134,11 @@
"description": "Name of a bucket.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1141,6 +1166,11 @@
"description": "Name of a bucket.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1171,6 +1201,11 @@
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1205,6 +1240,11 @@
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1249,6 +1289,11 @@
"description": "If set, only deletes the bucket if its metageneration does not match this value.",
"format": "int64",
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1296,6 +1341,11 @@
"Omit owner, acl and defaultObjectAcl properties."
],
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1323,6 +1373,11 @@
"description": "Name of a bucket.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1554,6 +1609,11 @@
"Omit owner, acl and defaultObjectAcl properties."
],
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1581,6 +1641,11 @@
"description": "Name of a bucket.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1616,6 +1681,11 @@
"required": true,
"repeated": true,
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1709,6 +1779,11 @@
"Omit owner, acl and defaultObjectAcl properties."
],
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1767,6 +1842,11 @@
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1795,6 +1875,11 @@
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1820,6 +1905,11 @@
"description": "Name of a bucket.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1859,6 +1949,11 @@
"description": "If present, only return default ACL listing if the bucket's current metageneration does not match the given value.",
"format": "int64",
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1889,6 +1984,11 @@
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1923,6 +2023,11 @@
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1961,6 +2066,11 @@
"description": "ID of the notification to delete.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -1990,6 +2100,11 @@
"description": "Notification ID",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2018,6 +2133,11 @@
"description": "The parent bucket of the notification.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2046,6 +2166,11 @@
"description": "Name of a GCS bucket.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2095,6 +2220,11 @@
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2136,6 +2266,11 @@
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2174,6 +2309,11 @@
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2214,6 +2354,11 @@
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2257,6 +2402,11 @@
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2304,6 +2454,11 @@
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2376,6 +2531,11 @@
"description": "Makes the operation conditional on whether the object's current metageneration matches the given value.",
"format": "int64",
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2513,6 +2673,11 @@
"description": "Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2582,6 +2747,11 @@
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2654,6 +2824,11 @@
"Omit the owner, acl property."
],
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2696,6 +2871,11 @@
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2792,6 +2972,11 @@
"Omit the owner, acl property."
],
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -2875,6 +3060,11 @@
],
"location": "query"
},
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
+ },
"versions": {
"type": "boolean",
"description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.",
@@ -2977,6 +3167,11 @@
"Omit the owner, acl property."
],
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -3122,6 +3317,11 @@
"description": "Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -3165,6 +3365,11 @@
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"required": true,
"location": "path"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -3213,6 +3418,11 @@
"required": true,
"repeated": true,
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -3312,6 +3522,11 @@
"Omit the owner, acl property."
],
"location": "query"
+ },
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
}
},
"parameterOrder": [
@@ -3379,6 +3594,11 @@
],
"location": "query"
},
+ "userProject": {
+ "type": "string",
+ "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ "location": "query"
+ },
"versions": {
"type": "boolean",
"description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.",
diff --git a/storage/v1/storage-gen.go b/storage/v1/storage-gen.go
index f25b670..913e231 100644
--- a/storage/v1/storage-gen.go
+++ b/storage/v1/storage-gen.go
@@ -197,6 +197,9 @@
// Acl: Access controls on the bucket.
Acl []*BucketAccessControl `json:"acl,omitempty"`
+ // Billing: The bucket's billing configuration.
+ Billing *BucketBilling `json:"billing,omitempty"`
+
// Cors: The bucket's Cross-Origin Resource Sharing (CORS)
// configuration.
Cors []*BucketCors `json:"cors,omitempty"`
@@ -300,6 +303,34 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// BucketBilling: The bucket's billing configuration.
+type BucketBilling struct {
+ // RequesterPays: When set to true, bucket is requester pays.
+ RequesterPays bool `json:"requesterPays,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "RequesterPays") 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. "RequesterPays") 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 *BucketBilling) MarshalJSON() ([]byte, error) {
+ type noMethod BucketBilling
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type BucketCors struct {
// MaxAgeSeconds: The value, in seconds, to return in the
// Access-Control-Max-Age header used in preflight responses.
@@ -1614,7 +1645,7 @@
// ObjectSize: The total size of the object being copied in bytes. This
// property is always present in the response.
- ObjectSize uint64 `json:"objectSize,omitempty,string"`
+ ObjectSize int64 `json:"objectSize,omitempty,string"`
// Resource: A resource containing the metadata for the copied-to
// object. This property is present in the response only when copying
@@ -1629,7 +1660,7 @@
// TotalBytesRewritten: The total bytes written so far, which can be
// used to provide a waiting user with a progress indicator. This
// property is always present in the response.
- TotalBytesRewritten uint64 `json:"totalBytesRewritten,omitempty,string"`
+ TotalBytesRewritten int64 `json:"totalBytesRewritten,omitempty,string"`
// ServerResponse contains the HTTP response code and headers from the
// server.
@@ -1768,6 +1799,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketAccessControlsDeleteCall) UserProject(userProject string) *BucketAccessControlsDeleteCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -1844,6 +1882,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/acl/{entity}",
@@ -1876,6 +1919,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketAccessControlsGetCall) UserProject(userProject string) *BucketAccessControlsGetCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -1990,6 +2040,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/acl/{entity}",
@@ -2023,6 +2078,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketAccessControlsInsertCall) UserProject(userProject string) *BucketAccessControlsInsertCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -2121,6 +2183,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/acl",
@@ -2156,6 +2223,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketAccessControlsListCall) UserProject(userProject string) *BucketAccessControlsListCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -2262,6 +2336,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/acl",
@@ -2298,6 +2377,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketAccessControlsPatchCall) UserProject(userProject string) *BucketAccessControlsPatchCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -2404,6 +2490,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/acl/{entity}",
@@ -2442,6 +2533,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketAccessControlsUpdateCall) UserProject(userProject string) *BucketAccessControlsUpdateCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -2548,6 +2646,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/acl/{entity}",
@@ -2598,6 +2701,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketsDeleteCall) UserProject(userProject string) *BucketsDeleteCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -2678,6 +2788,11 @@
// "format": "int64",
// "location": "query",
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}",
@@ -2737,6 +2852,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketsGetCall) UserProject(userProject string) *BucketsGetCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -2868,6 +2990,11 @@
// ],
// "location": "query",
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}",
@@ -2903,6 +3030,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketsGetIamPolicyCall) UserProject(userProject string) *BucketsGetIamPolicyCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -3009,6 +3143,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/iam",
@@ -3574,6 +3713,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketsPatchCall) UserProject(userProject string) *BucketsPatchCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -3737,6 +3883,11 @@
// ],
// "location": "query",
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}",
@@ -3773,6 +3924,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketsSetIamPolicyCall) UserProject(userProject string) *BucketsSetIamPolicyCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -3871,6 +4029,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/iam",
@@ -3909,6 +4072,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketsTestIamPermissionsCall) UserProject(userProject string) *BucketsTestIamPermissionsCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -4023,6 +4193,11 @@
// "repeated": true,
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/iam/testPermissions",
@@ -4129,6 +4304,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *BucketsUpdateCall) UserProject(userProject string) *BucketsUpdateCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -4292,6 +4474,11 @@
// ],
// "location": "query",
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}",
@@ -4423,6 +4610,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *DefaultObjectAccessControlsDeleteCall) UserProject(userProject string) *DefaultObjectAccessControlsDeleteCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -4499,6 +4693,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/defaultObjectAcl/{entity}",
@@ -4531,6 +4730,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *DefaultObjectAccessControlsGetCall) UserProject(userProject string) *DefaultObjectAccessControlsGetCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -4645,6 +4851,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/defaultObjectAcl/{entity}",
@@ -4679,6 +4890,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *DefaultObjectAccessControlsInsertCall) UserProject(userProject string) *DefaultObjectAccessControlsInsertCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -4777,6 +4995,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/defaultObjectAcl",
@@ -4829,6 +5052,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *DefaultObjectAccessControlsListCall) UserProject(userProject string) *DefaultObjectAccessControlsListCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -4947,6 +5177,11 @@
// "format": "int64",
// "location": "query",
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/defaultObjectAcl",
@@ -4983,6 +5218,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *DefaultObjectAccessControlsPatchCall) UserProject(userProject string) *DefaultObjectAccessControlsPatchCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -5089,6 +5331,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/defaultObjectAcl/{entity}",
@@ -5127,6 +5374,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *DefaultObjectAccessControlsUpdateCall) UserProject(userProject string) *DefaultObjectAccessControlsUpdateCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -5233,6 +5487,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/defaultObjectAcl/{entity}",
@@ -5269,6 +5528,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *NotificationsDeleteCall) UserProject(userProject string) *NotificationsDeleteCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -5345,6 +5611,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/notificationConfigs/{notification}",
@@ -5377,6 +5648,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *NotificationsGetCall) UserProject(userProject string) *NotificationsGetCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -5491,6 +5769,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/notificationConfigs/{notification}",
@@ -5527,6 +5810,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *NotificationsInsertCall) UserProject(userProject string) *NotificationsInsertCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -5625,6 +5915,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/notificationConfigs",
@@ -5662,6 +5957,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *NotificationsListCall) UserProject(userProject string) *NotificationsListCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -5768,6 +6070,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/notificationConfigs",
@@ -5815,6 +6122,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectAccessControlsDeleteCall) UserProject(userProject string) *ObjectAccessControlsDeleteCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -5905,6 +6219,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}/acl/{entity}",
@@ -5947,6 +6266,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectAccessControlsGetCall) UserProject(userProject string) *ObjectAccessControlsGetCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -6075,6 +6401,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}/acl/{entity}",
@@ -6118,6 +6449,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectAccessControlsInsertCall) UserProject(userProject string) *ObjectAccessControlsInsertCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -6230,6 +6568,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}/acl",
@@ -6275,6 +6618,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectAccessControlsListCall) UserProject(userProject string) *ObjectAccessControlsListCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -6395,6 +6745,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}/acl",
@@ -6441,6 +6796,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectAccessControlsPatchCall) UserProject(userProject string) *ObjectAccessControlsPatchCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -6561,6 +6923,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}/acl/{entity}",
@@ -6609,6 +6976,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectAccessControlsUpdateCall) UserProject(userProject string) *ObjectAccessControlsUpdateCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -6729,6 +7103,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}/acl/{entity}",
@@ -6805,6 +7184,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsComposeCall) UserProject(userProject string) *ObjectsComposeCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -6960,6 +7346,11 @@
// "format": "int64",
// "location": "query",
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{destinationBucket}/o/{destinationObject}/compose",
@@ -7117,6 +7508,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsCopyCall) UserProject(userProject string) *ObjectsCopyCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -7343,6 +7741,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}",
@@ -7425,6 +7828,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsDeleteCall) UserProject(userProject string) *ObjectsDeleteCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -7531,6 +7941,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}",
@@ -7615,6 +8030,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsGetCall) UserProject(userProject string) *ObjectsGetCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -7788,6 +8210,11 @@
// ],
// "location": "query",
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}",
@@ -7835,6 +8262,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsGetIamPolicyCall) UserProject(userProject string) *ObjectsGetIamPolicyCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -7955,6 +8389,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}/iam",
@@ -8081,6 +8520,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsInsertCall) UserProject(userProject string) *ObjectsInsertCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Media specifies the media to upload in one or more chunks. The chunk
// size may be controlled by supplying a MediaOption generated by
// googleapi.ChunkSize. The chunk size defaults to
@@ -8361,6 +8807,11 @@
// ],
// "location": "query",
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o",
@@ -8447,6 +8898,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsListCall) UserProject(userProject string) *ObjectsListCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Versions sets the optional parameter "versions": If true, lists all
// versions of an object as distinct results. The default is false. For
// more information, see Object Versioning.
@@ -8598,6 +9056,11 @@
// "location": "query",
// "type": "string"
// },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
+ // },
// "versions": {
// "description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.",
// "location": "query",
@@ -8735,6 +9198,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsPatchCall) UserProject(userProject string) *ObjectsPatchCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -8905,6 +9375,11 @@
// ],
// "location": "query",
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}",
@@ -9084,6 +9559,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsRewriteCall) UserProject(userProject string) *ObjectsRewriteCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -9305,6 +9787,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}",
@@ -9352,6 +9839,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsSetIamPolicyCall) UserProject(userProject string) *ObjectsSetIamPolicyCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -9464,6 +9958,11 @@
// "location": "path",
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}/iam",
@@ -9512,6 +10011,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsTestIamPermissionsCall) UserProject(userProject string) *ObjectsTestIamPermissionsCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -9640,6 +10146,11 @@
// "repeated": true,
// "required": true,
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}/iam/testPermissions",
@@ -9750,6 +10261,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsUpdateCall) UserProject(userProject string) *ObjectsUpdateCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -9936,6 +10454,11 @@
// ],
// "location": "query",
// "type": "string"
+ // },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
// }
// },
// "path": "b/{bucket}/o/{object}",
@@ -10021,6 +10544,13 @@
return c
}
+// UserProject sets the optional parameter "userProject": The project
+// number to be billed for this request, for Requester Pays buckets.
+func (c *ObjectsWatchAllCall) UserProject(userProject string) *ObjectsWatchAllCall {
+ c.urlParams_.Set("userProject", userProject)
+ return c
+}
+
// Versions sets the optional parameter "versions": If true, lists all
// versions of an object as distinct results. The default is false. For
// more information, see Object Versioning.
@@ -10164,6 +10694,11 @@
// "location": "query",
// "type": "string"
// },
+ // "userProject": {
+ // "description": "The project number to be billed for this request, for Requester Pays buckets.",
+ // "location": "query",
+ // "type": "string"
+ // },
// "versions": {
// "description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.",
// "location": "query",
diff --git a/storagetransfer/v1/storagetransfer-api.json b/storagetransfer/v1/storagetransfer-api.json
index 2ea627a..8783f6f 100644
--- a/storagetransfer/v1/storagetransfer-api.json
+++ b/storagetransfer/v1/storagetransfer-api.json
@@ -1,10 +1,4 @@
{
- "revision": "20170428",
- "documentationLink": "https://cloud.google.com/storage/transfer",
- "id": "storagetransfer:v1",
- "title": "Google Storage Transfer API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
"version_module": "True",
"resources": {
"googleServiceAccounts": {
@@ -13,10 +7,10 @@
"response": {
"$ref": "GoogleServiceAccount"
},
+ "httpMethod": "GET",
"parameterOrder": [
"projectId"
],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -37,30 +31,40 @@
},
"transferJobs": {
"methods": {
- "create": {
- "description": "Creates a transfer job that runs periodically.",
+ "patch": {
"request": {
- "$ref": "TransferJob"
+ "$ref": "UpdateTransferJobRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [],
+ "description": "Updates a transfer job. Updating a job's transfer spec does not affect\ntransfer operations that are running already. Updating the scheduling\nof a job is not allowed.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "jobName"
+ ],
"response": {
"$ref": "TransferJob"
},
+ "parameters": {
+ "jobName": {
+ "description": "The name of job to update.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^transferJobs/.+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {},
- "flatPath": "v1/transferJobs",
- "id": "storagetransfer.transferJobs.create",
- "path": "v1/transferJobs"
+ "flatPath": "v1/transferJobs/{transferJobsId}",
+ "id": "storagetransfer.transferJobs.patch",
+ "path": "v1/{+jobName}"
},
- "patch": {
- "description": "Updates a transfer job. Updating a job's transfer spec does not affect\ntransfer operations that are running already. Updating the scheduling\nof a job is not allowed.",
- "request": {
- "$ref": "UpdateTransferJobRequest"
- },
- "httpMethod": "PATCH",
+ "get": {
+ "flatPath": "v1/transferJobs/{transferJobsId}",
+ "id": "storagetransfer.transferJobs.get",
+ "path": "v1/{+jobName}",
+ "description": "Gets a transfer job.",
+ "httpMethod": "GET",
"parameterOrder": [
"jobName"
],
@@ -73,58 +77,29 @@
"parameters": {
"jobName": {
"location": "path",
- "description": "The name of job to update.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^transferJobs/.+$"
- }
- },
- "flatPath": "v1/transferJobs/{transferJobsId}",
- "id": "storagetransfer.transferJobs.patch",
- "path": "v1/{+jobName}"
- },
- "get": {
- "response": {
- "$ref": "TransferJob"
- },
- "parameterOrder": [
- "jobName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "jobName": {
"description": "The job to get.\nRequired.",
"required": true,
"type": "string",
- "pattern": "^transferJobs/.+$",
- "location": "path"
+ "pattern": "^transferJobs/.+$"
},
"projectId": {
"location": "query",
"description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
"type": "string"
}
- },
- "flatPath": "v1/transferJobs/{transferJobsId}",
- "path": "v1/{+jobName}",
- "id": "storagetransfer.transferJobs.get",
- "description": "Gets a transfer job."
+ }
},
"list": {
- "description": "Lists transfer jobs.",
- "httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "ListTransferJobsResponse"
},
+ "httpMethod": "GET",
+ "parameterOrder": [],
"parameters": {
"pageToken": {
+ "location": "query",
"description": "The list page token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"description": "The list page size. The max allowed value is 256.",
@@ -142,130 +117,41 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/transferJobs",
+ "path": "v1/transferJobs",
"id": "storagetransfer.transferJobs.list",
- "path": "v1/transferJobs"
+ "description": "Lists transfer jobs."
+ },
+ "create": {
+ "flatPath": "v1/transferJobs",
+ "id": "storagetransfer.transferJobs.create",
+ "path": "v1/transferJobs",
+ "request": {
+ "$ref": "TransferJob"
+ },
+ "description": "Creates a transfer job that runs periodically.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "TransferJob"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
},
"transferOperations": {
"methods": {
- "resume": {
- "request": {
- "$ref": "ResumeTransferOperationRequest"
- },
- "description": "Resumes a transfer operation that is paused.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the transfer operation.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^transferOperations/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/transferOperations/{transferOperationsId}:resume",
- "id": "storagetransfer.transferOperations.resume",
- "path": "v1/{+name}:resume"
- },
- "cancel": {
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^transferOperations/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/transferOperations/{transferOperationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "storagetransfer.transferOperations.cancel",
- "description": "Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation."
- },
- "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"
- ],
- "parameters": {
- "name": {
- "pattern": "^transferOperations/.+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/transferOperations/{transferOperationsId}",
- "id": "storagetransfer.transferOperations.get",
- "path": "v1/{+name}"
- },
- "pause": {
- "path": "v1/{+name}:pause",
- "id": "storagetransfer.transferOperations.pause",
- "description": "Pauses a transfer operation.",
- "request": {
- "$ref": "PauseTransferOperationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the transfer operation.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^transferOperations/.+$"
- }
- },
- "flatPath": "v1/transferOperations/{transferOperationsId}:pause"
- },
"delete": {
- "response": {
- "$ref": "Empty"
- },
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
@@ -275,102 +161,214 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/transferOperations/{transferOperationsId}",
- "path": "v1/{+name}",
"id": "storagetransfer.transferOperations.delete",
- "description": "This method is not supported and the server returns `UNIMPLEMENTED`."
+ "path": "v1/{+name}"
},
"list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "ListOperationsResponse"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
+ "name": {
+ "description": "The value `transferOperations`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^transferOperations$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The list page size. The max allowed value is 256.",
+ "format": "int32",
+ "type": "integer"
+ },
"filter": {
"location": "query",
"description": "A list of query parameters specified as JSON text in the form of {\\\"project_id\\\" : \\\"my_project_id\\\", \\\"job_names\\\" : [\\\"jobid1\\\", \\\"jobid2\\\",...], \\\"operation_names\\\" : [\\\"opid1\\\", \\\"opid2\\\",...], \\\"transfer_statuses\\\":[\\\"status1\\\", \\\"status2\\\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional.",
"type": "string"
- },
+ }
+ },
+ "flatPath": "v1/transferOperations",
+ "id": "storagetransfer.transferOperations.list",
+ "path": "v1/{+name}"
+ },
+ "resume": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
"name": {
"location": "path",
- "description": "The value `transferOperations`.",
+ "description": "The name of the transfer operation.\nRequired.",
"required": true,
"type": "string",
- "pattern": "^transferOperations$"
- },
- "pageToken": {
+ "pattern": "^transferOperations/.+$"
+ }
+ },
+ "flatPath": "v1/transferOperations/{transferOperationsId}:resume",
+ "path": "v1/{+name}:resume",
+ "id": "storagetransfer.transferOperations.resume",
+ "description": "Resumes a transfer operation that is paused.",
+ "request": {
+ "$ref": "ResumeTransferOperationRequest"
+ }
+ },
+ "cancel": {
+ "description": "Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
"type": "string",
- "location": "query",
- "description": "The list page token."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The list page size. The max allowed value is 256.",
- "format": "int32"
+ "pattern": "^transferOperations/.+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/transferOperations",
- "id": "storagetransfer.transferOperations.list",
+ "flatPath": "v1/transferOperations/{transferOperationsId}:cancel",
+ "id": "storagetransfer.transferOperations.cancel",
+ "path": "v1/{+name}:cancel"
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^transferOperations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/transferOperations/{transferOperationsId}",
"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`."
+ "id": "storagetransfer.transferOperations.get"
+ },
+ "pause": {
+ "description": "Pauses a transfer operation.",
+ "request": {
+ "$ref": "PauseTransferOperationRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the transfer operation.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^transferOperations/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/transferOperations/{transferOperationsId}:pause",
+ "id": "storagetransfer.transferOperations.pause",
+ "path": "v1/{+name}:pause"
}
}
}
},
"parameters": {
- "upload_protocol": {
+ "bearer_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "OAuth bearer token.",
"type": "string"
},
- "prettyPrint": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "type": "string",
"location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
+ "prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "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"
},
- "uploadType": {
+ "callback": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "JSONP",
"type": "string"
},
"$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "location": "query",
- "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": [
@@ -378,75 +376,44 @@
"media",
"proto"
],
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "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": {
+ "pp": {
"location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
}
},
"schemas": {
- "TimeOfDay": {
- "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
- "type": "object",
- "properties": {
- "hours": {
- "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
- "format": "int32",
- "type": "integer"
- },
- "nanos": {
- "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
- "format": "int32",
- "type": "integer"
- },
- "seconds": {
- "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
- "format": "int32",
- "type": "integer"
- },
- "minutes": {
- "description": "Minutes of hour of day. Must be from 0 to 59.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TimeOfDay"
- },
"ErrorLogEntry": {
"description": "An entry describing an error that has occurred.",
"type": "object",
"properties": {
"url": {
- "description": "A URL that refers to the target (a data source, a data sink,\nor an object) with which the error is associated.\nRequired.",
- "type": "string"
+ "type": "string",
+ "description": "A URL that refers to the target (a data source, a data sink,\nor an object) with which the error is associated.\nRequired."
},
"errorDetails": {
"description": "A list of messages that carry the error details.",
@@ -459,21 +426,9 @@
"id": "ErrorLogEntry"
},
"TransferJob": {
+ "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
"type": "object",
"properties": {
- "schedule": {
- "description": "Schedule specification.\nRequired.",
- "$ref": "Schedule"
- },
- "name": {
- "description": "A globally unique name assigned by Storage Transfer Service when the\njob is created. This field should be left empty in requests to create a new\ntransfer job; otherwise, the requests result in an `INVALID_ARGUMENT`\nerror.",
- "type": "string"
- },
- "deletionTime": {
- "type": "string",
- "description": "This field cannot be changed by user requests.",
- "format": "google-datetime"
- },
"projectId": {
"description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
"type": "string"
@@ -484,25 +439,19 @@
"type": "string"
},
"description": {
- "type": "string",
- "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded."
+ "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
+ "type": "string"
},
"creationTime": {
- "type": "string",
"description": "This field cannot be changed by user requests.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"transferSpec": {
- "description": "Transfer specification.\nRequired.",
- "$ref": "TransferSpec"
+ "$ref": "TransferSpec",
+ "description": "Transfer specification.\nRequired."
},
"status": {
- "enumDescriptions": [
- "Zero is an illegal value.",
- "New transfers will be performed based on the schedule.",
- "New transfers will not be scheduled.",
- "This is a soft delete state. After a transfer job is set to this\nstate, the job and all the transfer executions are subject to\ngarbage collection."
- ],
"enum": [
"STATUS_UNSPECIFIED",
"ENABLED",
@@ -510,40 +459,54 @@
"DELETED"
],
"description": "Status of the job. This value MUST be specified for\n`CreateTransferJobRequests`.\n\nNOTE: The effect of the new job status takes place during a subsequent job\nrun. For example, if you change the job status from `ENABLED` to\n`DISABLED`, and an operation spawned by the transfer is running, the status\nchange would not affect the current operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Zero is an illegal value.",
+ "New transfers will be performed based on the schedule.",
+ "New transfers will not be scheduled.",
+ "This is a soft delete state. After a transfer job is set to this\nstate, the job and all the transfer executions are subject to\ngarbage collection."
+ ]
+ },
+ "schedule": {
+ "$ref": "Schedule",
+ "description": "Schedule specification.\nRequired."
+ },
+ "name": {
+ "type": "string",
+ "description": "A globally unique name assigned by Storage Transfer Service when the\njob is created. This field should be left empty in requests to create a new\ntransfer job; otherwise, the requests result in an `INVALID_ARGUMENT`\nerror."
+ },
+ "deletionTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
"type": "string"
}
},
- "id": "TransferJob",
- "description": "This resource represents the configuration of a transfer job that runs\nperiodically."
+ "id": "TransferJob"
},
"Schedule": {
"description": "Transfers can be scheduled to recur or to run just once.",
"type": "object",
"properties": {
- "scheduleStartDate": {
- "description": "The first day the recurring transfer is scheduled to run. If\n`scheduleStartDate` is in the past, the transfer will run for the first\ntime on the following day.\nRequired.",
- "$ref": "Date"
- },
"scheduleEndDate": {
- "description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce.",
- "$ref": "Date"
+ "$ref": "Date",
+ "description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce."
},
"startTimeOfDay": {
- "$ref": "TimeOfDay",
- "description": "The time in UTC at which the transfer will be scheduled to start in a day.\nTransfers may start later than this time. If not specified, recurring and\none-time transfers that are scheduled to run today will run immediately;\nrecurring transfers that are scheduled to run on a future date will start\nat approximately midnight UTC on that date. Note that when configuring a\ntransfer with the Cloud Platform Console, the transfer's start time in a\nday is specified in your local timezone."
+ "description": "The time in UTC at which the transfer will be scheduled to start in a day.\nTransfers may start later than this time. If not specified, recurring and\none-time transfers that are scheduled to run today will run immediately;\nrecurring transfers that are scheduled to run on a future date will start\nat approximately midnight UTC on that date. Note that when configuring a\ntransfer with the Cloud Platform Console, the transfer's start time in a\nday is specified in your local timezone.",
+ "$ref": "TimeOfDay"
+ },
+ "scheduleStartDate": {
+ "$ref": "Date",
+ "description": "The first day the recurring transfer is scheduled to run. If\n`scheduleStartDate` is in the past, the transfer will run for the first\ntime on the following day.\nRequired."
}
},
"id": "Schedule"
},
"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": {
- "type": "integer",
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32"
- },
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
@@ -553,27 +516,51 @@
"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"
+ }
},
"TransferOperation": {
- "id": "TransferOperation",
"description": "A description of the execution of a transfer.",
"type": "object",
"properties": {
- "transferJobName": {
+ "errorBreakdowns": {
+ "description": "Summarizes errors encountered with sample error log entries.",
+ "type": "array",
+ "items": {
+ "$ref": "ErrorSummary"
+ }
+ },
+ "name": {
+ "description": "A globally unique ID assigned by the system.",
+ "type": "string"
+ },
+ "projectId": {
"type": "string",
- "description": "The name of the transfer job that triggers this transfer operation."
+ "description": "The ID of the Google Cloud Platform Console project that owns the operation.\nRequired."
+ },
+ "endTime": {
+ "description": "End time of this transfer execution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start time of this transfer execution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "transferJobName": {
+ "description": "The name of the transfer job that triggers this transfer operation.",
+ "type": "string"
},
"transferSpec": {
"$ref": "TransferSpec",
"description": "Transfer specification.\nRequired."
},
- "counters": {
- "$ref": "TransferCounters",
- "description": "Information about the progress of the transfer operation."
- },
"status": {
"type": "string",
"enumDescriptions": [
@@ -594,35 +581,14 @@
],
"description": "Status of the transfer operation."
},
- "errorBreakdowns": {
- "description": "Summarizes errors encountered with sample error log entries.",
- "type": "array",
- "items": {
- "$ref": "ErrorSummary"
- }
- },
- "name": {
- "description": "A globally unique ID assigned by the system.",
- "type": "string"
- },
- "projectId": {
- "description": "The ID of the Google Cloud Platform Console project that owns the operation.\nRequired.",
- "type": "string"
- },
- "endTime": {
- "description": "End time of this transfer execution.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Start time of this transfer execution.",
- "format": "google-datetime",
- "type": "string"
+ "counters": {
+ "description": "Information about the progress of the transfer operation.",
+ "$ref": "TransferCounters"
}
- }
+ },
+ "id": "TransferOperation"
},
"AwsS3Data": {
- "type": "object",
"properties": {
"bucketName": {
"description": "S3 Bucket name (see\n[Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).\nRequired.",
@@ -634,16 +600,10 @@
}
},
"id": "AwsS3Data",
- "description": "An AwsS3Data can be a data source, but not a data sink.\nIn an AwsS3Data, an object's name is the S3 object's key name."
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
+ "description": "An AwsS3Data can be a data source, but not a data sink.\nIn an AwsS3Data, an object's name is the S3 object's key name.",
+ "type": "object"
},
"AwsAccessKey": {
- "id": "AwsAccessKey",
"description": "AWS access key (see\n[AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).",
"type": "object",
"properties": {
@@ -655,70 +615,25 @@
"description": "AWS secret access key. This field is not returned in RPC responses.\nRequired.",
"type": "string"
}
- }
+ },
+ "id": "AwsAccessKey"
},
- "PauseTransferOperationRequest": {
+ "Empty": {
"properties": {},
- "id": "PauseTransferOperationRequest",
- "description": "Request passed to PauseTransferOperation.",
+ "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"
},
- "TransferCounters": {
- "description": "A collection of counters that report the progress of a transfer operation.",
+ "PauseTransferOperationRequest": {
+ "description": "Request passed to PauseTransferOperation.",
"type": "object",
+ "properties": {},
+ "id": "PauseTransferOperationRequest"
+ },
+ "TransferCounters": {
"properties": {
- "objectsFoundOnlyFromSink": {
- "description": "Objects found only in the data sink that are scheduled to be deleted.",
- "format": "int64",
- "type": "string"
- },
- "objectsDeletedFromSink": {
- "description": "Objects that are deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesFromSourceSkippedBySync": {
- "description": "Bytes in the data source that are not transferred because they already\nexist in the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesDeletedFromSink": {
- "description": "Bytes that are deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesFailedToDeleteFromSink": {
- "description": "Bytes that failed to be deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
- "bytesFromSourceFailed": {
- "description": "Bytes in the data source that failed during the transfer.",
- "format": "int64",
- "type": "string"
- },
- "objectsFromSourceFailed": {
- "description": "Objects in the data source that failed during the transfer.",
- "format": "int64",
- "type": "string"
- },
- "objectsCopiedToSink": {
- "type": "string",
- "description": "Objects that are copied to the data sink.",
- "format": "int64"
- },
- "bytesFoundOnlyFromSink": {
- "description": "Bytes found only in the data sink that are scheduled to be deleted.",
- "format": "int64",
- "type": "string"
- },
- "objectsDeletedFromSource": {
- "description": "Objects that are deleted from the data source.",
- "format": "int64",
- "type": "string"
- },
- "bytesCopiedToSink": {
- "description": "Bytes that are copied to the data sink.",
+ "bytesFoundFromSource": {
+ "description": "Bytes found in the data source that are scheduled to be transferred,\nwhich will be copied, excluded based on conditions, or skipped due to\nfailures.",
"format": "int64",
"type": "string"
},
@@ -727,8 +642,8 @@
"format": "int64",
"type": "string"
},
- "bytesFoundFromSource": {
- "description": "Bytes found in the data source that are scheduled to be transferred,\nwhich will be copied, excluded based on conditions, or skipped due to\nfailures.",
+ "bytesDeletedFromSource": {
+ "description": "Bytes that are deleted from the data source.",
"format": "int64",
"type": "string"
},
@@ -737,23 +652,85 @@
"format": "int64",
"type": "string"
},
- "bytesDeletedFromSource": {
- "description": "Bytes that are deleted from the data source.",
- "format": "int64",
- "type": "string"
- },
"objectsFailedToDeleteFromSink": {
"description": "Objects that failed to be deleted from the data sink.",
"format": "int64",
"type": "string"
+ },
+ "objectsFoundOnlyFromSink": {
+ "description": "Objects found only in the data sink that are scheduled to be deleted.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsDeletedFromSink": {
+ "type": "string",
+ "description": "Objects that are deleted from the data sink.",
+ "format": "int64"
+ },
+ "bytesFromSourceSkippedBySync": {
+ "description": "Bytes in the data source that are not transferred because they already\nexist in the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bytesFailedToDeleteFromSink": {
+ "description": "Bytes that failed to be deleted from the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bytesDeletedFromSink": {
+ "description": "Bytes that are deleted from the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bytesFromSourceFailed": {
+ "description": "Bytes in the data source that failed during the transfer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsCopiedToSink": {
+ "description": "Objects that are copied to the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsFromSourceFailed": {
+ "type": "string",
+ "description": "Objects in the data source that failed during the transfer.",
+ "format": "int64"
+ },
+ "bytesFoundOnlyFromSink": {
+ "description": "Bytes found only in the data sink that are scheduled to be deleted.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsDeletedFromSource": {
+ "type": "string",
+ "description": "Objects that are deleted from the data source.",
+ "format": "int64"
+ },
+ "bytesCopiedToSink": {
+ "description": "Bytes that are copied to the data sink.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "TransferCounters"
+ "id": "TransferCounters",
+ "description": "A collection of counters that report the progress of a transfer operation.",
+ "type": "object"
},
"ErrorSummary": {
+ "description": "A summary of errors by error code, plus a count and sample error log\nentries.",
"type": "object",
"properties": {
+ "errorLogEntries": {
+ "description": "Error samples.",
+ "type": "array",
+ "items": {
+ "$ref": "ErrorLogEntry"
+ }
+ },
"errorCode": {
+ "description": "Required.",
+ "type": "string",
"enumDescriptions": [
"Not an error; returned on success\n\nHTTP Mapping: 200 OK",
"The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request",
@@ -791,36 +768,26 @@
"INTERNAL",
"UNAVAILABLE",
"DATA_LOSS"
- ],
- "description": "Required.",
- "type": "string"
+ ]
},
"errorCount": {
+ "type": "string",
"description": "Count of this type of error.\nRequired.",
- "format": "int64",
- "type": "string"
- },
- "errorLogEntries": {
- "description": "Error samples.",
- "type": "array",
- "items": {
- "$ref": "ErrorLogEntry"
- }
+ "format": "int64"
}
},
- "id": "ErrorSummary",
- "description": "A summary of errors by error code, plus a count and sample error log\nentries."
+ "id": "ErrorSummary"
},
"HttpData": {
+ "description": "An HttpData specifies a list of objects on the web to be transferred over\nHTTP. The information of the objects to be transferred is contained in a\nfile referenced by a URL. The first line in the file must be\n\"TsvHttpData-1.0\", which specifies the format of the file. Subsequent lines\nspecify the information of the list of objects, one object per list entry.\nEach entry has the following tab-delimited fields:\n\n* HTTP URL - The location of the object.\n\n* Length - The size of the object in bytes.\n\n* MD5 - The base64-encoded MD5 hash of the object.\n\nFor an example of a valid TSV file, see\n[Transferring data from URLs](https://cloud.google.com/storage/transfer/#urls)\n\nWhen transferring data based on a URL list, keep the following in mind:\n\n* When an object located at `http(s)://hostname:port/\u003cURL-path\u003e` is transferred\nto a data sink, the name of the object at the data sink is\n`\u003chostname\u003e/\u003cURL-path\u003e`.\n\n* If the specified size of an object does not match the actual size of the\nobject fetched, the object will not be transferred.\n\n* If the specified MD5 does not match the MD5 computed from the transferred\nbytes, the object transfer will fail. For more information, see\n[Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5)\n\n* Ensure that each URL you specify is publicly accessible. For\nexample, in Google Cloud Storage you can\n[share an object publicly]\n(https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get\na link to it.\n\n* Storage Transfer Service obeys `robots.txt` rules and requires the source\nHTTP server to support `Range` requests and to return a `Content-Length`\nheader in each response.\n\n* [ObjectConditions](#ObjectConditions) have no effect when filtering objects\nto transfer.",
+ "type": "object",
"properties": {
"listUrl": {
"description": "The URL that points to the file that stores the object list entries.\nThis file must allow public access. Currently, only URLs with HTTP and\nHTTPS schemes are supported.\nRequired.",
"type": "string"
}
},
- "id": "HttpData",
- "description": "An HttpData specifies a list of objects on the web to be transferred over\nHTTP. The information of the objects to be transferred is contained in a\nfile referenced by a URL. The first line in the file must be\n\"TsvHttpData-1.0\", which specifies the format of the file. Subsequent lines\nspecify the information of the list of objects, one object per list entry.\nEach entry has the following tab-delimited fields:\n\n* HTTP URL - The location of the object.\n\n* Length - The size of the object in bytes.\n\n* MD5 - The base64-encoded MD5 hash of the object.\n\nFor an example of a valid TSV file, see\n[Transferring data from URLs](https://cloud.google.com/storage/transfer/#urls)\n\nWhen transferring data based on a URL list, keep the following in mind:\n\n* When an object located at `http(s)://hostname:port/\u003cURL-path\u003e` is transferred\nto a data sink, the name of the object at the data sink is\n`\u003chostname\u003e/\u003cURL-path\u003e`.\n\n* If the specified size of an object does not match the actual size of the\nobject fetched, the object will not be transferred.\n\n* If the specified MD5 does not match the MD5 computed from the transferred\nbytes, the object transfer will fail. For more information, see\n[Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5)\n\n* Ensure that each URL you specify is publicly accessible. For\nexample, in Google Cloud Storage you can\n[share an object publicly]\n(https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get\na link to it.\n\n* Storage Transfer Service obeys `robots.txt` rules and requires the source\nHTTP server to support `Range` requests and to return a `Content-Length`\nheader in each response.\n\n* [ObjectConditions](#ObjectConditions) have no effect when filtering objects\nto transfer.",
- "type": "object"
+ "id": "HttpData"
},
"GcsData": {
"description": "In a GcsData, an object's name is the Google Cloud Storage object's name and\nits `lastModificationTime` refers to the object's updated time, which changes\nwhen the content or the metadata of the object is updated.",
@@ -834,22 +801,22 @@
"id": "GcsData"
},
"ListTransferJobsResponse": {
- "id": "ListTransferJobsResponse",
- "description": "Response from ListTransferJobs.",
- "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The list next page token.",
+ "type": "string"
+ },
"transferJobs": {
"description": "A list of transfer jobs.",
"type": "array",
"items": {
"$ref": "TransferJob"
}
- },
- "nextPageToken": {
- "description": "The list next page token.",
- "type": "string"
}
- }
+ },
+ "id": "ListTransferJobsResponse",
+ "description": "Response from ListTransferJobs.",
+ "type": "object"
},
"UpdateTransferJobRequest": {
"description": "Request passed to UpdateTransferJob.",
@@ -875,18 +842,6 @@
"description": "Conditions that determine which objects will be transferred.",
"type": "object",
"properties": {
- "minTimeElapsedSinceLastModification": {
- "description": "If unspecified, `minTimeElapsedSinceLastModification` takes a zero value\nand `maxTimeElapsedSinceLastModification` takes the maximum possible\nvalue of Duration. Objects that satisfy the object conditions\nmust either have a `lastModificationTime` greater or equal to\n`NOW` - `maxTimeElapsedSinceLastModification` and less than\n`NOW` - `minTimeElapsedSinceLastModification`, or not have a\n`lastModificationTime`.",
- "format": "google-duration",
- "type": "string"
- },
- "excludePrefixes": {
- "description": "`excludePrefixes` must follow the requirements described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 1000.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"maxTimeElapsedSinceLastModification": {
"description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`.",
"format": "google-duration",
@@ -898,6 +853,18 @@
"items": {
"type": "string"
}
+ },
+ "minTimeElapsedSinceLastModification": {
+ "description": "If unspecified, `minTimeElapsedSinceLastModification` takes a zero value\nand `maxTimeElapsedSinceLastModification` takes the maximum possible\nvalue of Duration. Objects that satisfy the object conditions\nmust either have a `lastModificationTime` greater or equal to\n`NOW` - `maxTimeElapsedSinceLastModification` and less than\n`NOW` - `minTimeElapsedSinceLastModification`, or not have a\n`lastModificationTime`.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "excludePrefixes": {
+ "description": "`excludePrefixes` must follow the requirements described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 1000.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "ObjectConditions"
@@ -906,26 +873,6 @@
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
"metadata": {
"description": "Represents the transfer operation object.",
"type": "object",
@@ -933,11 +880,51 @@
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
}
},
"id": "Operation"
},
+ "TransferOptions": {
+ "description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
+ "type": "object",
+ "properties": {
+ "overwriteObjectsAlreadyExistingInSink": {
+ "type": "boolean",
+ "description": "Whether overwriting objects that already exist in the sink is allowed."
+ },
+ "deleteObjectsFromSourceAfterTransfer": {
+ "description": "Whether objects should be deleted from the source after they are\ntransferred to the sink.",
+ "type": "boolean"
+ },
+ "deleteObjectsUniqueInSink": {
+ "type": "boolean",
+ "description": "Whether objects that exist only in the sink should be deleted."
+ }
+ },
+ "id": "TransferOptions"
+ },
"TransferSpec": {
+ "id": "TransferSpec",
"description": "Configuration for running a transfer.",
"type": "object",
"properties": {
@@ -950,8 +937,8 @@
"description": "Only objects that satisfy these object conditions are included in the set\nof data source and data sink objects. Object conditions based on\nobjects' `lastModificationTime` do not exclude objects in a data sink."
},
"gcsDataSink": {
- "description": "A Google Cloud Storage data sink.",
- "$ref": "GcsData"
+ "$ref": "GcsData",
+ "description": "A Google Cloud Storage data sink."
},
"gcsDataSource": {
"$ref": "GcsData",
@@ -962,63 +949,43 @@
"description": "If the option `deleteObjectsUniqueInSink` is `true`, object conditions\nbased on objects' `lastModificationTime` are ignored and do not exclude\nobjects in a data source or a data sink."
},
"awsS3DataSource": {
- "$ref": "AwsS3Data",
- "description": "An AWS S3 data source."
+ "description": "An AWS S3 data source.",
+ "$ref": "AwsS3Data"
}
- },
- "id": "TransferSpec"
- },
- "TransferOptions": {
- "properties": {
- "overwriteObjectsAlreadyExistingInSink": {
- "description": "Whether overwriting objects that already exist in the sink is allowed.",
- "type": "boolean"
- },
- "deleteObjectsFromSourceAfterTransfer": {
- "description": "Whether objects should be deleted from the source after they are\ntransferred to the sink.",
- "type": "boolean"
- },
- "deleteObjectsUniqueInSink": {
- "description": "Whether objects that exist only in the sink should be deleted.",
- "type": "boolean"
- }
- },
- "id": "TransferOptions",
- "description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
- "type": "object"
+ }
},
"Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"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": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "type": "object"
}
},
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
- "id": "Status",
- "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"
},
"ResumeTransferOperationRequest": {
- "id": "ResumeTransferOperationRequest",
"description": "Request passed to ResumeTransferOperation.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "ResumeTransferOperationRequest"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -1048,11 +1015,38 @@
}
},
"id": "GoogleServiceAccount"
+ },
+ "TimeOfDay": {
+ "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
+ "type": "object",
+ "properties": {
+ "minutes": {
+ "description": "Minutes of hour of day. Must be from 0 to 59.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hours": {
+ "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "nanos": {
+ "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "seconds": {
+ "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TimeOfDay"
}
},
"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",
@@ -1066,12 +1060,18 @@
}
}
},
- "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
"servicePath": "",
+ "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
"kind": "discovery#restDescription",
"rootUrl": "https://storagetransfer.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "storagetransfer",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "id": "storagetransfer:v1",
+ "documentationLink": "https://cloud.google.com/storage/transfer",
+ "revision": "20170601",
+ "title": "Google Storage Transfer API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/storagetransfer/v1/storagetransfer-gen.go b/storagetransfer/v1/storagetransfer-gen.go
index d48ce18..268be8a 100644
--- a/storagetransfer/v1/storagetransfer-gen.go
+++ b/storagetransfer/v1/storagetransfer-gen.go
@@ -975,7 +975,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -1008,7 +1008,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
@@ -2670,9 +2670,18 @@
// server doesn't support this method, it returns
// `UNIMPLEMENTED`.
//
-// NOTE: the `name` binding below allows API services to override the
+// NOTE: the `name` binding allows API services to override the
// binding
// to use different resource name schemes, such as `users/*/operations`.
+// To
+// override the binding, API services can add a binding such
+// as
+// "/v1/{name=users/*}/operations" to their service configuration.
+// For backwards compatibility, the default name includes the
+// operations
+// collection id, however overriding users must ensure the name
+// binding
+// is the parent resource, without the operations collection id.
func (r *TransferOperationsService) List(name string) *TransferOperationsListCall {
c := &TransferOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -2800,7 +2809,7 @@
}
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`.",
+ // "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
// "flatPath": "v1/transferOperations",
// "httpMethod": "GET",
// "id": "storagetransfer.transferOperations.list",
diff --git a/toolresults/v1beta3/toolresults-api.json b/toolresults/v1beta3/toolresults-api.json
index 379f665..d104570 100644
--- a/toolresults/v1beta3/toolresults-api.json
+++ b/toolresults/v1beta3/toolresults-api.json
@@ -1,12 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/1Xydnc-jA1JGA7bzJCFJV63Vl9w\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/YcTPtBUCccEq3Dc53lfQyi5qiFQ\"",
"discoveryVersion": "v1",
"id": "toolresults:v1beta3",
"name": "toolresults",
"canonicalName": "Tool Results",
"version": "v1beta3",
- "revision": "20170509",
+ "revision": "20170601",
"title": "Cloud Tool Results API",
"description": "Reads and publishes results from Firebase Test Lab.",
"ownerDomain": "google.com",
@@ -80,7 +80,7 @@
"Any": {
"id": "Any",
"type": "object",
- "description": "`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }\n\nExample 3: Pack and unpack a message in Python.\n\nfoo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...\n\nThe pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example \"foo.bar.com/x/y.z\" will yield type name \"y.z\".\n\n\n\nJSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:\n\npackage google.profile; message Person { string first_name = 1; string last_name = 2; }\n\n{ \"@type\": \"type.googleapis.com/google.profile.Person\", \"firstName\": , \"lastName\": }\n\nIf the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):\n\n{ \"@type\": \"type.googleapis.com/google.protobuf.Duration\", \"value\": \"1.212s\" }",
+ "description": "`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }\n\nExample 3: Pack and unpack a message in Python.\n\nfoo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...\n\nExample 4: Pack and unpack a message in Go\n\nfoo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... }\n\nThe pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example \"foo.bar.com/x/y.z\" will yield type name \"y.z\".\n\n\n\nJSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:\n\npackage google.profile; message Person { string first_name = 1; string last_name = 2; }\n\n{ \"@type\": \"type.googleapis.com/google.profile.Person\", \"firstName\": , \"lastName\": }\n\nIf the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):\n\n{ \"@type\": \"type.googleapis.com/google.protobuf.Duration\", \"value\": \"1.212s\" }",
"properties": {
"typeUrl": {
"type": "string",
@@ -1086,7 +1086,7 @@
"id": "toolresults.projects.initializeSettings",
"path": "{projectId}:initializeSettings",
"httpMethod": "POST",
- "description": "Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in the name of the user calling. Except in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the project-private ACL: All project team members are given permissions to the bucket and objects created within it according to their roles. Project owners have owners rights, and so on. The default ACL on objects created in the bucket is project-private as well. See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deteleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage",
+ "description": "Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage",
"parameters": {
"projectId": {
"type": "string",
diff --git a/toolresults/v1beta3/toolresults-gen.go b/toolresults/v1beta3/toolresults-gen.go
index 8cfeb73..e275d37 100644
--- a/toolresults/v1beta3/toolresults-gen.go
+++ b/toolresults/v1beta3/toolresults-gen.go
@@ -191,6 +191,12 @@
// foo = Foo(...) any = Any() any.Pack(foo) ... if
// any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
//
+// Example 4: Pack and unpack a message in Go
+//
+// foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo :=
+// &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ...
+// }
+//
// The pack methods provided by protobuf library will by default use
// 'type.googleapis.com/full.type.name' as the type URL and the unpack
// methods only use the fully qualified type name after the last '/' in
@@ -2643,23 +2649,24 @@
//
// Currently, this creates a single resource: a Google Cloud Storage
// bucket, to be used as the default bucket for this project. The bucket
-// is created in the name of the user calling. Except in rare cases,
+// is created in an FTL-own storage project. Except for in rare cases,
// calling this method in parallel from multiple clients will only
// create a single bucket. In order to avoid unnecessary storage
// charges, the bucket is configured to automatically delete objects
// older than 90 days.
//
-// The bucket is created with the project-private ACL: All project team
-// members are given permissions to the bucket and objects created
-// within it according to their roles. Project owners have owners
-// rights, and so on. The default ACL on objects created in the bucket
-// is project-private as well. See Google Cloud Storage documentation
-// for more details.
+// The bucket is created with the following permissions: - Owner access
+// for owners of central storage project (FTL-owned) - Writer access for
+// owners/editors of customer project - Reader access for viewers of
+// customer project The default ACL on objects created in the bucket is:
+// - Owner access for owners of central storage project - Reader access
+// for owners/editors/viewers of customer project See Google Cloud
+// Storage documentation for more details.
//
// If there is already a default bucket set and the project can access
// the bucket, this call does nothing. However, if the project doesn't
-// have the permission to access the bucket or the bucket is deteleted,
-// a new bucket will be created.
+// have the permission to access the bucket or the bucket is deleted, a
+// new bucket will be created.
//
// May return any canonical error codes, including the following:
//
@@ -2752,7 +2759,7 @@
}
return ret, nil
// {
- // "description": "Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in the name of the user calling. Except in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the project-private ACL: All project team members are given permissions to the bucket and objects created within it according to their roles. Project owners have owners rights, and so on. The default ACL on objects created in the bucket is project-private as well. See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deteleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage",
+ // "description": "Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage",
// "httpMethod": "POST",
// "id": "toolresults.projects.initializeSettings",
// "parameterOrder": [
diff --git a/toolresults/v1beta3firstparty/toolresults-api.json b/toolresults/v1beta3firstparty/toolresults-api.json
index d1377ed..0110a7c 100644
--- a/toolresults/v1beta3firstparty/toolresults-api.json
+++ b/toolresults/v1beta3firstparty/toolresults-api.json
@@ -1,12 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/ppo1iLLqiUIwsCs0-kKy5KJsndc\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/B4WBJkOsNHyaT-ZZb1Ht0OVHCAs\"",
"discoveryVersion": "v1",
"id": "toolresults:v1beta3firstparty",
"name": "toolresults",
"canonicalName": "Tool Results",
"version": "v1beta3firstparty",
- "revision": "20170509",
+ "revision": "20170601",
"title": "Cloud Tool Results firstparty API",
"description": "Reads and publishes results from Firebase Test Lab.",
"ownerDomain": "google.com",
@@ -71,7 +71,7 @@
"Any": {
"id": "Any",
"type": "object",
- "description": "`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }\n\nExample 3: Pack and unpack a message in Python.\n\nfoo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...\n\nThe pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example \"foo.bar.com/x/y.z\" will yield type name \"y.z\".\n\n\n\nJSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:\n\npackage google.profile; message Person { string first_name = 1; string last_name = 2; }\n\n{ \"@type\": \"type.googleapis.com/google.profile.Person\", \"firstName\": , \"lastName\": }\n\nIf the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):\n\n{ \"@type\": \"type.googleapis.com/google.protobuf.Duration\", \"value\": \"1.212s\" }",
+ "description": "`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }\n\nExample 3: Pack and unpack a message in Python.\n\nfoo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...\n\nExample 4: Pack and unpack a message in Go\n\nfoo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... }\n\nThe pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example \"foo.bar.com/x/y.z\" will yield type name \"y.z\".\n\n\n\nJSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:\n\npackage google.profile; message Person { string first_name = 1; string last_name = 2; }\n\n{ \"@type\": \"type.googleapis.com/google.profile.Person\", \"firstName\": , \"lastName\": }\n\nIf the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):\n\n{ \"@type\": \"type.googleapis.com/google.protobuf.Duration\", \"value\": \"1.212s\" }",
"properties": {
"typeUrl": {
"type": "string",
@@ -1074,7 +1074,7 @@
"id": "toolresults.projects.initializeSettings",
"path": "{projectId}:initializeSettings",
"httpMethod": "POST",
- "description": "Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in the name of the user calling. Except in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the project-private ACL: All project team members are given permissions to the bucket and objects created within it according to their roles. Project owners have owners rights, and so on. The default ACL on objects created in the bucket is project-private as well. See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deteleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage",
+ "description": "Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage",
"parameters": {
"projectId": {
"type": "string",
diff --git a/toolresults/v1beta3firstparty/toolresults-gen.go b/toolresults/v1beta3firstparty/toolresults-gen.go
index ac1d24d..6ec0e61 100644
--- a/toolresults/v1beta3firstparty/toolresults-gen.go
+++ b/toolresults/v1beta3firstparty/toolresults-gen.go
@@ -185,6 +185,12 @@
// foo = Foo(...) any = Any() any.Pack(foo) ... if
// any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
//
+// Example 4: Pack and unpack a message in Go
+//
+// foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo :=
+// &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ...
+// }
+//
// The pack methods provided by protobuf library will by default use
// 'type.googleapis.com/full.type.name' as the type URL and the unpack
// methods only use the fully qualified type name after the last '/' in
@@ -2634,23 +2640,24 @@
//
// Currently, this creates a single resource: a Google Cloud Storage
// bucket, to be used as the default bucket for this project. The bucket
-// is created in the name of the user calling. Except in rare cases,
+// is created in an FTL-own storage project. Except for in rare cases,
// calling this method in parallel from multiple clients will only
// create a single bucket. In order to avoid unnecessary storage
// charges, the bucket is configured to automatically delete objects
// older than 90 days.
//
-// The bucket is created with the project-private ACL: All project team
-// members are given permissions to the bucket and objects created
-// within it according to their roles. Project owners have owners
-// rights, and so on. The default ACL on objects created in the bucket
-// is project-private as well. See Google Cloud Storage documentation
-// for more details.
+// The bucket is created with the following permissions: - Owner access
+// for owners of central storage project (FTL-owned) - Writer access for
+// owners/editors of customer project - Reader access for viewers of
+// customer project The default ACL on objects created in the bucket is:
+// - Owner access for owners of central storage project - Reader access
+// for owners/editors/viewers of customer project See Google Cloud
+// Storage documentation for more details.
//
// If there is already a default bucket set and the project can access
// the bucket, this call does nothing. However, if the project doesn't
-// have the permission to access the bucket or the bucket is deteleted,
-// a new bucket will be created.
+// have the permission to access the bucket or the bucket is deleted, a
+// new bucket will be created.
//
// May return any canonical error codes, including the following:
//
@@ -2743,7 +2750,7 @@
}
return ret, nil
// {
- // "description": "Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in the name of the user calling. Except in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the project-private ACL: All project team members are given permissions to the bucket and objects created within it according to their roles. Project owners have owners rights, and so on. The default ACL on objects created in the bucket is project-private as well. See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deteleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage",
+ // "description": "Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage",
// "httpMethod": "POST",
// "id": "toolresults.projects.initializeSettings",
// "parameterOrder": [
diff --git a/tracing/v2/tracing-api.json b/tracing/v2/tracing-api.json
index 624a891..17efc11 100644
--- a/tracing/v2/tracing-api.json
+++ b/tracing/v2/tracing-api.json
@@ -1,71 +1,561 @@
{
+ "rootUrl": "https://tracing.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "tracing",
+ "batchPath": "batch",
+ "title": "Google Tracing API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "traces": {
+ "methods": {
+ "list": {
+ "description": "Returns of a list of traces that match the specified filter conditions.",
+ "response": {
+ "$ref": "ListTracesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
+ "parameters": {
+ "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 which is\n`projects/PROJECT_ID`.",
+ "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": {
+ "location": "query",
+ "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"
+ },
+ "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": {
+ "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/traces",
+ "path": "v2/{+parent}/traces",
+ "id": "tracing.projects.traces.list"
+ },
+ "batchWrite": {
+ "request": {
+ "$ref": "BatchWriteSpansRequest"
+ },
+ "description": "Sends new spans to Stackdriver Trace or updates existing traces. If the\nname of a trace that you send matches that of an existing trace, new spans\nare added to the existing trace. Attempt to update existing spans results\nundefined behavior. If the name does not match, a new trace is created\nwith given set of spans.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Name of the project where the spans belong to. Format is\n`projects/PROJECT_ID`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.append"
+ ],
+ "flatPath": "v2/projects/{projectsId}/traces:batchWrite",
+ "id": "tracing.projects.traces.batchWrite",
+ "path": "v2/{+name}/traces:batchWrite"
+ },
+ "listSpans": {
+ "description": "Returns a list of spans within a trace.",
+ "response": {
+ "$ref": "ListSpansResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "ID of the trace for which to list child spans. Format is\n`projects/PROJECT_ID/traces/TRACE_ID`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/traces/[^/]+$"
+ },
+ "pageToken": {
+ "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `nextPageToken` field from a previous request. Optional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
+ "flatPath": "v2/projects/{projectsId}/traces/{tracesId}:listSpans",
+ "path": "v2/{+parent}:listSpans",
+ "id": "tracing.projects.traces.listSpans"
+ }
+ },
+ "resources": {
+ "spans": {
+ "methods": {
+ "create": {
+ "flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}",
+ "path": "v2/{+name}",
+ "id": "tracing.projects.traces.spans.create",
+ "description": "Creates a new Span.",
+ "request": {
+ "$ref": "Span"
+ },
+ "response": {
+ "$ref": "Span"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.append"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of Span in the format\n`projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.\n`TRACE_ID` is a unique identifier for a trace within a project and is a\nbase16-encoded, case-insensitive string and is required to be 32 char long.\n`SPAN_ID` is a unique identifier for a span within a trace. It is a\nbase 16-encoded, case-insensitive string of a 8-bytes array and is required\nto be 16 char long.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$",
+ "location": "path"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "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": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "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": "v2",
+ "baseUrl": "https://tracing.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Send and retrieve trace data from Google Stackdriver Trace.\n",
+ "servicePath": "",
+ "basePath": "",
+ "documentationLink": "https://cloud.google.com/trace",
+ "id": "tracing:v2",
+ "revision": "20170531",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "NetworkEvent": {
- "description": "An event describing an RPC message sent/received on the network. A\nmaximum of 128 network events are allowed per Span.",
- "type": "object",
+ "Status": {
"properties": {
- "time": {
- "description": "If available, this is the kernel time:\n\n* For sent messages, this is the time at which the first bit was sent.\n* For received messages, this is the time at which the last bit was\n received.",
- "format": "google-datetime",
- "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"
+ }
},
- "type": {
- "enumDescriptions": [
- "Unknown event type.",
- "Indicates a sent RPC message.",
- "Indicates a received RPC message."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "SENT",
- "RECV"
- ],
- "description": "Type of NetworkEvent. Indicates whether the RPC message was sent or\nreceived.",
- "type": "string"
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
},
- "messageId": {
- "description": "An identifier for the message, which must be unique in this span.",
- "format": "uint64",
+ "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"
- },
- "messageSize": {
- "type": "string",
- "description": "The number of bytes sent or received.",
- "format": "uint64"
}
},
- "id": "NetworkEvent"
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
},
- "ListSpansResponse": {
- "description": "The response message for the `ListSpans` method.",
- "type": "object",
+ "BatchWriteSpansRequest": {
"properties": {
- "nextPageToken": {
- "description": "If defined, indicates that there are more spans that match the request.\nPass this as the value of `pageToken` in a subsequent request to retrieve\nadditional spans.",
- "type": "string"
- },
"spans": {
- "description": "The requested spans if there are any in the specified trace.",
+ "description": "A collection of spans.",
"type": "array",
"items": {
"$ref": "Span"
}
}
},
- "id": "ListSpansResponse"
+ "id": "BatchWriteSpansRequest",
+ "description": "The request message for the `BatchWriteSpans` method.",
+ "type": "object"
},
- "StackFrame": {
+ "ListTracesResponse": {
+ "description": "The response message for the `ListTraces` method.",
"type": "object",
"properties": {
- "originalFunctionName": {
- "description": "Used when the function name is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). May be\nfully-qualified (up to 1024 characters).",
- "$ref": "TruncatableString"
+ "traces": {
+ "description": "List of trace records returned.",
+ "type": "array",
+ "items": {
+ "$ref": "Trace"
+ }
},
- "functionName": {
+ "nextPageToken": {
+ "description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
+ "type": "string"
+ }
+ },
+ "id": "ListTracesResponse"
+ },
+ "Span": {
+ "description": "A span represents a single operation within a trace. Spans can be nested\nto form a trace tree. Often, a trace contains a root span that\ndescribes the end-to-end latency and, optionally, one or more subspans for\nits sub-operations. (A trace could alternatively contain multiple root spans,\nor none at all.) Spans do not need to be contiguous. There may be gaps\nand/or overlaps between spans in a trace.",
+ "type": "object",
+ "properties": {
+ "displayName": {
"$ref": "TruncatableString",
- "description": "The fully-qualified name that uniquely identifies this function or\nmethod (up to 1024 characters)."
+ "description": "Description of the operation in the span. It is sanitized and displayed in\nthe Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe display_name may be a method name or some other per-call site\nname. For the same executable and the same call point, a best practice is\nto use a consistent operation name, which makes it easier to correlate\ncross-trace spans.\nThe maximum length for the display_name is 128 bytes."
+ },
+ "timeEvents": {
+ "description": "A maximum of 32 annotations and 128 network events are allowed per Span.",
+ "$ref": "TimeEvents"
+ },
+ "status": {
+ "description": "An optional final status for this span.",
+ "$ref": "Status"
+ },
+ "name": {
+ "description": "The resource name of Span in the format\n`projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.\n`TRACE_ID` is a unique identifier for a trace within a project and is a\nbase16-encoded, case-insensitive string and is required to be 32 char long.\n`SPAN_ID` is a unique identifier for a span within a trace. It is a\nbase 16-encoded, case-insensitive string of a 8-bytes array and is required\nto be 16 char long.",
+ "type": "string"
+ },
+ "stackTrace": {
+ "$ref": "StackTrace",
+ "description": "Stack trace captured at the start of the span."
+ },
+ "links": {
+ "$ref": "Links",
+ "description": "A maximum of 128 links are allowed per Span."
+ },
+ "attributes": {
+ "$ref": "Attributes",
+ "description": "A set of attributes on the span. A maximum of 32 attributes are allowed per\nSpan."
+ },
+ "spanId": {
+ "description": "Unique identifier for a span within a trace. It is a base 16-encoded,\ncase-insensitive string of a 8-bytes array and is required.",
+ "type": "string"
+ },
+ "parentSpanId": {
+ "description": "ID of parent span which is a base 16-encoded, case-insensitive string of\na 8-bytes array and is required to be 16 char long. If this is a root span,\nthe value must be empty.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End time of the span.\nOn the client side, this is the local machine clock time at which the span\nexecution was ended; on the server\nside, this is the time at which the server application handler stopped\nrunning.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start time of the span.\nOn the client side, this is the local machine clock time at which the span\nexecution was started; on the server\nside, this is the time at which the server application handler started\nrunning.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Span"
+ },
+ "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": "The allowed types for the value side of an attribute key:value pair.",
+ "type": "object",
+ "properties": {
+ "intValue": {
+ "description": "An integer value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "stringValue": {
+ "$ref": "TruncatableString",
+ "description": "A string value (up to 256 bytes)."
+ },
+ "boolValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ }
+ },
+ "id": "AttributeValue"
+ },
+ "Attributes": {
+ "description": "Attributes of a span with a key:value format.",
+ "type": "object",
+ "properties": {
+ "droppedAttributesCount": {
+ "description": "The number of dropped attributes after the maximum size was enforced. If\n0 then no attributes were dropped.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "attributeMap": {
+ "additionalProperties": {
+ "$ref": "AttributeValue"
+ },
+ "description": "The maximum key length is 128 bytes (attributes are dropped if the\nkey size is larger than the maximum allowed). The value can be a string\n(up to 256 bytes), integer, or boolean (true/false). Some common pair\nexamples:\n\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 \"abc.com/myattribute\": true",
+ "type": "object"
+ }
+ },
+ "id": "Attributes"
+ },
+ "Links": {
+ "description": "A collection of links, which are references from this span to a span\nin the same or different trace.",
+ "type": "object",
+ "properties": {
+ "droppedLinksCount": {
+ "description": "The number of dropped links after the maximum size was enforced. If\n0 then no links were dropped.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "link": {
+ "description": "A collection of links.",
+ "type": "array",
+ "items": {
+ "$ref": "Link"
+ }
+ }
+ },
+ "id": "Links"
+ },
+ "TruncatableString": {
+ "description": "Represents a string value that might be truncated.",
+ "type": "object",
+ "properties": {
+ "truncatedCharacterCount": {
+ "description": "The number of characters truncated from the original string value. If 0 it\nmeans that the string value was not truncated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "value": {
+ "description": "The truncated string value. E.g. for a string attribute this may have up to\n256 bytes.",
+ "type": "string"
+ }
+ },
+ "id": "TruncatableString"
+ },
+ "StackTrace": {
+ "description": "StackTrace collected in a trace.",
+ "type": "object",
+ "properties": {
+ "stackTraceHashId": {
+ "description": "The hash ID is used to conserve network bandwidth for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurrence of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSubsequent spans within the same request can refer\nto that stack trace by only setting `stackTraceHashId`.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "stackFrames": {
+ "$ref": "StackFrames",
+ "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
+ }
+ },
+ "id": "StackTrace"
+ },
+ "TimeEvent": {
+ "description": "A time-stamped annotation in the Span.",
+ "type": "object",
+ "properties": {
+ "time": {
+ "description": "The timestamp indicating the time the event occurred.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "networkEvent": {
+ "$ref": "NetworkEvent",
+ "description": "An event describing an RPC message sent/received on the network."
+ },
+ "annotation": {
+ "description": "One or more key:value pairs.",
+ "$ref": "Annotation"
+ }
+ },
+ "id": "TimeEvent"
+ },
+ "NetworkEvent": {
+ "description": "An event describing an RPC message sent/received on the network. A\nmaximum of 128 network events are allowed per Span.",
+ "type": "object",
+ "properties": {
+ "messageSize": {
+ "description": "The number of bytes sent or received.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "time": {
+ "description": "If available, this is the kernel time:\n\n* For sent messages, this is the time at which the first bit was sent.\n* For received messages, this is the time at which the last bit was\n received.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "SENT",
+ "RECV"
+ ],
+ "description": "Type of NetworkEvent. Indicates whether the RPC message was sent or\nreceived.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown event type.",
+ "Indicates a sent RPC message.",
+ "Indicates a received RPC message."
+ ]
+ },
+ "messageId": {
+ "description": "An identifier for the message, which must be unique in this span.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "id": "NetworkEvent"
+ },
+ "ListSpansResponse": {
+ "properties": {
+ "spans": {
+ "description": "The requested spans if there 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.\nPass this as the value of `pageToken` in a subsequent request to retrieve\nadditional spans.",
+ "type": "string"
+ }
+ },
+ "id": "ListSpansResponse",
+ "description": "The response message for the `ListSpans` method.",
+ "type": "object"
+ },
+ "StackFrame": {
+ "properties": {
+ "functionName": {
+ "description": "The fully-qualified name that uniquely identifies this function or\nmethod (up to 1024 characters).",
+ "$ref": "TruncatableString"
},
"lineNumber": {
"description": "Line number of the frame.",
@@ -73,8 +563,8 @@
"type": "string"
},
"loadModule": {
- "$ref": "Module",
- "description": "Binary module the code is loaded from."
+ "description": "Binary module the code is loaded from.",
+ "$ref": "Module"
},
"columnNumber": {
"description": "Column number is important in JavaScript (anonymous functions).\nMay not be available in some languages.",
@@ -82,33 +572,38 @@
"type": "string"
},
"fileName": {
- "$ref": "TruncatableString",
- "description": "The filename of the file containing this frame (up to 256 characters)."
+ "description": "The filename of the file containing this frame (up to 256 characters).",
+ "$ref": "TruncatableString"
},
"sourceVersion": {
- "$ref": "TruncatableString",
- "description": "The version of the deployed source code (up to 128 characters)."
+ "description": "The version of the deployed source code (up to 128 characters).",
+ "$ref": "TruncatableString"
+ },
+ "originalFunctionName": {
+ "description": "Used when the function name is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). May be\nfully-qualified (up to 1024 characters).",
+ "$ref": "TruncatableString"
}
},
"id": "StackFrame",
- "description": "Represents a single stack frame in a stack trace."
+ "description": "Represents a single stack frame in a stack trace.",
+ "type": "object"
},
"Link": {
"description": "A pointer from this span to another span in a different `Trace` within\nthe same service project or within a different service project. Used\n(for example) in batching operations, where a single batch handler\nprocesses multiple requests from different traces or when receives a\nrequest from a different service project.",
"type": "object",
"properties": {
"type": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CHILD",
+ "PARENT"
+ ],
"description": "The relationship of the current span relative to the linked span.",
"type": "string",
"enumDescriptions": [
"The relationship of the two spans is unknown.",
"The current span is a child of the linked span.",
"The current span is the parent of the linked span."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "CHILD",
- "PARENT"
]
},
"traceId": {
@@ -131,8 +626,8 @@
"description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes."
},
"attributes": {
- "description": "A set of attributes on the annotation. A maximum of 4 attributes are\nallowed per Annotation.",
- "$ref": "Attributes"
+ "$ref": "Attributes",
+ "description": "A set of attributes on the annotation. A maximum of 4 attributes are\nallowed per Annotation."
}
},
"id": "Annotation"
@@ -168,10 +663,14 @@
"id": "Trace"
},
"TimeEvents": {
- "id": "TimeEvents",
"description": "A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation\non the span, consisting of either user-supplied key:value pairs, or\ndetails of an RPC message sent/received on the network.",
"type": "object",
"properties": {
+ "droppedNetworkEventsCount": {
+ "description": "The number of dropped network events after the maximum size was enforced.\nIf 0 then no annotations were dropped.",
+ "format": "int32",
+ "type": "integer"
+ },
"droppedAnnotationsCount": {
"description": "The number of dropped annotations after the maximum size was enforced. If\n0 then no annotations were dropped.",
"format": "int32",
@@ -183,256 +682,24 @@
"items": {
"$ref": "TimeEvent"
}
- },
- "droppedNetworkEventsCount": {
- "type": "integer",
- "description": "The number of dropped network events after the maximum size was enforced.\nIf 0 then no annotations were dropped.",
- "format": "int32"
}
- }
+ },
+ "id": "TimeEvents"
},
"Module": {
"description": "Binary module.",
"type": "object",
"properties": {
- "module": {
- "$ref": "TruncatableString",
- "description": "E.g. main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 characters)."
- },
"buildId": {
"$ref": "TruncatableString",
"description": "Build_id is a unique identifier for the module, usually a hash of its\ncontents (up to 128 characters)."
+ },
+ "module": {
+ "$ref": "TruncatableString",
+ "description": "E.g. main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 characters)."
}
},
"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": {
- "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"
- },
- "BatchWriteSpansRequest": {
- "id": "BatchWriteSpansRequest",
- "description": "The request message for the `BatchWriteSpans` method.",
- "type": "object",
- "properties": {
- "spans": {
- "description": "A collection of spans.",
- "type": "array",
- "items": {
- "$ref": "Span"
- }
- }
- }
- },
- "ListTracesResponse": {
- "properties": {
- "traces": {
- "description": "List of trace records returned.",
- "type": "array",
- "items": {
- "$ref": "Trace"
- }
- },
- "nextPageToken": {
- "description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
- "type": "string"
- }
- },
- "id": "ListTracesResponse",
- "description": "The response message for the `ListTraces` method.",
- "type": "object"
- },
- "Span": {
- "description": "A span represents a single operation within a trace. Spans can be nested\nto form a trace tree. Often, a trace contains a root span that\ndescribes the end-to-end latency and, optionally, one or more subspans for\nits sub-operations. (A trace could alternatively contain multiple root spans,\nor none at all.) Spans do not need to be contiguous. There may be gaps\nand/or overlaps between spans in a trace.",
- "type": "object",
- "properties": {
- "status": {
- "description": "An optional final status for this span.",
- "$ref": "Status"
- },
- "name": {
- "description": "The resource name of Span in the format\n`projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.\n`TRACE_ID` is a unique identifier for a trace within a project and is a\nbase16-encoded, case-insensitive string and is required to be 32 char long.\n`SPAN_ID` is a unique identifier for a span within a trace. It is a\nbase 16-encoded, case-insensitive string of a 8-bytes array and is required\nto be 16 char long.",
- "type": "string"
- },
- "stackTrace": {
- "description": "Stack trace captured at the start of the span.",
- "$ref": "StackTrace"
- },
- "links": {
- "description": "A maximum of 128 links are allowed per Span.",
- "$ref": "Links"
- },
- "attributes": {
- "$ref": "Attributes",
- "description": "A set of attributes on the span. A maximum of 32 attributes are allowed per\nSpan."
- },
- "spanId": {
- "description": "Unique identifier for a span within a trace. It is a base 16-encoded,\ncase-insensitive string of a 8-bytes array and is required.",
- "type": "string"
- },
- "parentSpanId": {
- "description": "ID of parent span which is a base 16-encoded, case-insensitive string of\na 8-bytes array and is required to be 16 char long. If this is a root span,\nthe value must be empty.",
- "type": "string"
- },
- "endTime": {
- "description": "End time of the span.\nOn the client side, this is the local machine clock time at which the span\nexecution was ended; on the server\nside, this is the time at which the server application handler stopped\nrunning.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Start time of the span.\nOn the client side, this is the local machine clock time at which the span\nexecution was started; on the server\nside, this is the time at which the server application handler started\nrunning.",
- "format": "google-datetime",
- "type": "string"
- },
- "displayName": {
- "description": "Description of the operation in the span. It is sanitized and displayed in\nthe Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe display_name may be a method name or some other per-call site\nname. For the same executable and the same call point, a best practice is\nto use a consistent operation name, which makes it easier to correlate\ncross-trace spans.\nThe maximum length for the display_name is 128 bytes.",
- "$ref": "TruncatableString"
- },
- "timeEvents": {
- "$ref": "TimeEvents",
- "description": "A maximum of 32 annotations and 128 network events are allowed per Span."
- }
- },
- "id": "Span"
- },
- "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": "The allowed types for the value side of an attribute key:value pair.",
- "type": "object",
- "properties": {
- "stringValue": {
- "$ref": "TruncatableString",
- "description": "A string value (up to 256 bytes)."
- },
- "boolValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
- "intValue": {
- "description": "An integer value.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "AttributeValue"
- },
- "Attributes": {
- "id": "Attributes",
- "description": "Attributes of a span with a key:value format.",
- "type": "object",
- "properties": {
- "droppedAttributesCount": {
- "description": "The number of dropped attributes after the maximum size was enforced. If\n0 then no attributes were dropped.",
- "format": "int32",
- "type": "integer"
- },
- "attributeMap": {
- "description": "The maximum key length is 128 bytes (attributes are dropped if the\nkey size is larger than the maximum allowed). The value can be a string\n(up to 256 bytes), integer, or boolean (true/false). Some common pair\nexamples:\n\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 \"abc.com/myattribute\": true",
- "type": "object",
- "additionalProperties": {
- "$ref": "AttributeValue"
- }
- }
- }
- },
- "Links": {
- "properties": {
- "droppedLinksCount": {
- "description": "The number of dropped links after the maximum size was enforced. If\n0 then no links were dropped.",
- "format": "int32",
- "type": "integer"
- },
- "link": {
- "description": "A collection of links.",
- "type": "array",
- "items": {
- "$ref": "Link"
- }
- }
- },
- "id": "Links",
- "description": "A collection of links, which are references from this span to a span\nin the same or different trace.",
- "type": "object"
- },
- "StackTrace": {
- "description": "StackTrace collected in a trace.",
- "type": "object",
- "properties": {
- "stackTraceHashId": {
- "type": "string",
- "description": "The hash ID is used to conserve network bandwidth for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurance of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSubsequent spans within the same request can refer\nto that stack trace by only setting `stackTraceHashId`.",
- "format": "uint64"
- },
- "stackFrames": {
- "$ref": "StackFrames",
- "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
- }
- },
- "id": "StackTrace"
- },
- "TruncatableString": {
- "description": "Represents a string value that might be truncated.",
- "type": "object",
- "properties": {
- "truncatedCharacterCount": {
- "description": "The number of characters truncated from the original string value. If 0 it\nmeans that the string value was not truncated.",
- "format": "int32",
- "type": "integer"
- },
- "value": {
- "description": "The truncated string value. E.g. for a string attribute this may have up to\n256 bytes.",
- "type": "string"
- }
- },
- "id": "TruncatableString"
- },
- "TimeEvent": {
- "description": "A time-stamped annotation in the Span.",
- "type": "object",
- "properties": {
- "time": {
- "description": "The timestamp indicating the time the event occurred.",
- "format": "google-datetime",
- "type": "string"
- },
- "networkEvent": {
- "$ref": "NetworkEvent",
- "description": "An event describing an RPC message sent/received on the network."
- },
- "annotation": {
- "description": "One or more key:value pairs.",
- "$ref": "Annotation"
- }
- },
- "id": "TimeEvent"
}
},
"icons": {
@@ -455,272 +722,5 @@
}
}
}
- },
- "rootUrl": "https://tracing.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "tracing",
- "batchPath": "batch",
- "title": "Google Tracing API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "traces": {
- "methods": {
- "batchWrite": {
- "request": {
- "$ref": "BatchWriteSpansRequest"
- },
- "description": "Sends new spans to Stackdriver Trace or updates existing traces. If the\nname of a trace that you send matches that of an existing trace, new spans\nare added to the existing trace. Attempt to update existing spans results\nundefined behavior. If the name does not match, a new trace is created\nwith given set of spans.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "Name of the project where the spans belong to. Format is\n`projects/PROJECT_ID`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.append"
- ],
- "flatPath": "v2/projects/{projectsId}/traces:batchWrite",
- "path": "v2/{+name}/traces:batchWrite",
- "id": "tracing.projects.traces.batchWrite"
- },
- "listSpans": {
- "response": {
- "$ref": "ListSpansResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `nextPageToken` field from a previous request. Optional."
- },
- "parent": {
- "description": "ID of the trace for which to list child spans. Format is\n`projects/PROJECT_ID/traces/TRACE_ID`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/traces/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
- "flatPath": "v2/projects/{projectsId}/traces/{tracesId}:listSpans",
- "path": "v2/{+parent}:listSpans",
- "id": "tracing.projects.traces.listSpans",
- "description": "Returns a list of spans within a trace."
- },
- "list": {
- "flatPath": "v2/projects/{projectsId}/traces",
- "path": "v2/{+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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored which is\n`projects/PROJECT_ID`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "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."
- },
- "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": {
- "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
- "type": "string",
- "location": "query"
- },
- "startTime": {
- "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "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"
- }
- }
- }
- },
- "resources": {
- "spans": {
- "methods": {
- "create": {
- "path": "v2/{+name}",
- "id": "tracing.projects.traces.spans.create",
- "request": {
- "$ref": "Span"
- },
- "description": "Creates a new Span.",
- "response": {
- "$ref": "Span"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$",
- "location": "path",
- "description": "The resource name of Span in the format\n`projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.\n`TRACE_ID` is a unique identifier for a trace within a project and is a\nbase16-encoded, case-insensitive string and is required to be 32 char long.\n`SPAN_ID` is a unique identifier for a span within a trace. It is a\nbase 16-encoded, case-insensitive string of a 8-bytes array and is required\nto be 16 char long.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.append"
- ],
- "flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}"
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v2",
- "baseUrl": "https://tracing.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Send and retrieve trace data from Google Stackdriver Trace.\n",
- "servicePath": "",
- "basePath": "",
- "id": "tracing:v2",
- "documentationLink": "https://cloud.google.com/trace",
- "revision": "20170425"
+ }
}
diff --git a/tracing/v2/tracing-gen.go b/tracing/v2/tracing-gen.go
index ca7085b..8312508 100644
--- a/tracing/v2/tracing-gen.go
+++ b/tracing/v2/tracing-gen.go
@@ -756,7 +756,7 @@
// stack traces within a single trace.
//
// Often multiple spans will have identical stack traces.
- // The first occurance of a stack trace should contain both
+ // The first occurrence of a stack trace should contain both
// the
// `stackFrame` content and a value in `stackTraceHashId`.
//
@@ -815,7 +815,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -848,7 +848,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
diff --git a/translate/v2/translate-api.json b/translate/v2/translate-api.json
index d816dfd..8c620ab 100644
--- a/translate/v2/translate-api.json
+++ b/translate/v2/translate-api.json
@@ -1,267 +1,440 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/6s__cFeA5l1i01rONlu3TmUQEHs\"",
- "discoveryVersion": "v1",
- "id": "translate:v2",
- "name": "translate",
- "version": "v2",
- "revision": "20160627",
- "title": "Translate API",
- "description": "Translates text from one language to another.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/translate-16.png",
- "x32": "https://www.google.com/images/icons/product/translate-32.png"
- },
- "documentationLink": "https://developers.google.com/translate/v2/using_rest",
- "protocol": "rest",
- "baseUrl": "https://www.googleapis.com/language/translate/",
- "basePath": "/language/translate/",
- "rootUrl": "https://www.googleapis.com/",
- "servicePath": "language/translate/",
- "batchPath": "batch",
- "parameters": {
- "alt": {
- "type": "string",
- "description": "Data format for the response.",
- "default": "json",
- "enum": [
- "json"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json"
- ],
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
- "location": "query"
- },
- "userIp": {
- "type": "string",
- "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
- "location": "query"
- }
- },
- "features": [
- "dataWrapper"
- ],
- "schemas": {
- "DetectionsListResponse": {
- "id": "DetectionsListResponse",
- "type": "object",
- "properties": {
+ "ownerName": "Google",
+ "resources": {
"detections": {
- "type": "array",
- "description": "A detections contains detection results of several text",
- "items": {
- "$ref": "DetectionsResource"
- }
- }
- }
- },
- "DetectionsResource": {
- "id": "DetectionsResource",
- "type": "array",
- "description": "An array of languages which we detect for the given text The most likely language list first.",
- "items": {
- "type": "object",
- "properties": {
- "confidence": {
- "type": "number",
- "description": "The confidence of the detection resul of this language.",
- "format": "float"
- },
- "isReliable": {
- "type": "boolean",
- "description": "A boolean to indicate is the language detection result reliable."
- },
- "language": {
- "type": "string",
- "description": "The language we detect"
- }
- }
- }
- },
- "LanguagesListResponse": {
- "id": "LanguagesListResponse",
- "type": "object",
- "properties": {
+ "methods": {
+ "list": {
+ "description": "Detects the language of text within a request.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "DetectionsListResponse"
+ },
+ "parameterOrder": [
+ "q"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "q": {
+ "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
+ "type": "string",
+ "required": true,
+ "repeated": true,
+ "location": "query"
+ }
+ },
+ "id": "language.detections.list",
+ "path": "v2/detect"
+ },
+ "detect": {
+ "response": {
+ "$ref": "DetectionsListResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "path": "v2/detect",
+ "id": "language.detections.detect",
+ "request": {
+ "$ref": "DetectLanguageRequest"
+ },
+ "description": "Detects the language of text within a request."
+ }
+ }
+ },
"languages": {
- "type": "array",
- "description": "List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language.",
- "items": {
- "$ref": "LanguagesResource"
- }
- }
- }
- },
- "LanguagesResource": {
- "id": "LanguagesResource",
- "type": "object",
- "properties": {
- "language": {
- "type": "string",
- "description": "The language code."
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "LanguagesListResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "target": {
+ "location": "query",
+ "description": "The language to use to return localized, human readable names of supported\nlanguages.",
+ "type": "string"
+ },
+ "model": {
+ "description": "The model type for which supported languages should be returned.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "id": "language.languages.list",
+ "path": "v2/languages",
+ "description": "Returns a list of supported languages for translation."
+ }
+ }
},
- "name": {
- "type": "string",
- "description": "The localized name of the language if target parameter is given."
- }
- }
- },
- "TranslationsListResponse": {
- "id": "TranslationsListResponse",
- "type": "object",
- "properties": {
"translations": {
- "type": "array",
- "description": "Translations contains list of translation results of given text",
- "items": {
- "$ref": "TranslationsResource"
- }
+ "methods": {
+ "list": {
+ "parameterOrder": [
+ "q",
+ "target"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "TranslationsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "model": {
+ "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
+ "type": "string",
+ "location": "query"
+ },
+ "q": {
+ "repeated": true,
+ "location": "query",
+ "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
+ "type": "string",
+ "required": true
+ },
+ "source": {
+ "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.",
+ "type": "string",
+ "location": "query"
+ },
+ "cid": {
+ "description": "The customization id for translate",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "target": {
+ "location": "query",
+ "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
+ "type": "string",
+ "required": true
+ },
+ "format": {
+ "enum": [
+ "html",
+ "text"
+ ],
+ "description": "The format of the source text, in either HTML (default) or plain-text. A\nvalue of \"html\" indicates HTML and a value of \"text\" indicates plain-text.",
+ "type": "string",
+ "enumDescriptions": [
+ "Specifies the input is in HTML",
+ "Specifies the input is in plain textual format"
+ ],
+ "location": "query"
+ }
+ },
+ "path": "v2",
+ "id": "language.translations.list",
+ "description": "Translates input text, returning translated text."
+ },
+ "translate": {
+ "response": {
+ "$ref": "TranslationsListResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "path": "v2",
+ "id": "language.translations.translate",
+ "description": "Translates input text, returning translated text.",
+ "request": {
+ "$ref": "TranslateTextRequest"
+ }
+ }
+ }
}
- }
},
- "TranslationsResource": {
- "id": "TranslationsResource",
- "type": "object",
- "properties": {
- "detectedSourceLanguage": {
- "type": "string",
- "description": "Detected source language if source parameter is unspecified."
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
- "translatedText": {
- "type": "string",
- "description": "The translation."
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "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": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "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"
}
- }
- }
- },
- "resources": {
- "detections": {
- "methods": {
- "list": {
- "id": "language.detections.list",
- "path": "v2/detect",
- "httpMethod": "GET",
- "description": "Detect the language of text.",
- "parameters": {
- "q": {
- "type": "string",
- "description": "The text to detect",
- "required": true,
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "q"
- ],
- "response": {
- "$ref": "DetectionsListResponse"
- }
- }
- }
},
- "languages": {
- "methods": {
- "list": {
- "id": "language.languages.list",
- "path": "v2/languages",
- "httpMethod": "GET",
- "description": "List the source/target languages supported by the API",
- "parameters": {
- "target": {
- "type": "string",
- "description": "the language and collation in which the localized results should be returned",
- "location": "query"
- }
- },
- "response": {
- "$ref": "LanguagesListResponse"
- }
+ "version": "v2",
+ "baseUrl": "https://translation.googleapis.com/language/translate/",
+ "kind": "discovery#restDescription",
+ "description": "The Google Cloud Translation API lets websites and programs integrate with\n Google Translate programmatically.",
+ "servicePath": "language/translate/",
+ "basePath": "/language/translate/",
+ "revision": "20170525",
+ "documentationLink": "https://code.google.com/apis/language/translate/v2/getting_started.html",
+ "id": "translate:v2",
+ "discoveryVersion": "v1",
+ "schemas": {
+ "LanguagesResource": {
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "Supported language code, generally consisting of its ISO 639-1\nidentifier. (E.g. 'en', 'ja'). In certain cases, BCP-47 codes including\nlanguage + region identifiers are returned (e.g. 'zh-TW' and 'zh-CH')",
+ "type": "string"
+ },
+ "name": {
+ "description": "Human readable name of the language localized to the target language.",
+ "type": "string"
+ }
+ },
+ "id": "LanguagesResource"
+ },
+ "DetectionsListResponse": {
+ "properties": {
+ "detections": {
+ "description": "A detections contains detection results of several text",
+ "type": "array",
+ "items": {
+ "$ref": "DetectionsResource"
+ }
+ }
+ },
+ "id": "DetectionsListResponse",
+ "type": "object"
+ },
+ "GetSupportedLanguagesRequest": {
+ "description": "The request message for discovering supported languages.",
+ "type": "object",
+ "properties": {
+ "target": {
+ "description": "The language to use to return localized, human readable names of supported\nlanguages.",
+ "type": "string"
+ }
+ },
+ "id": "GetSupportedLanguagesRequest"
+ },
+ "LanguagesListResponse": {
+ "properties": {
+ "languages": {
+ "description": "List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language.",
+ "type": "array",
+ "items": {
+ "$ref": "LanguagesResource"
+ }
+ }
+ },
+ "id": "LanguagesListResponse",
+ "type": "object"
+ },
+ "TranslationsResource": {
+ "type": "object",
+ "properties": {
+ "model": {
+ "description": "The `model` type used for this translation. Valid values are\nlisted in public documentation. Can be different from requested `model`.\nPresent only if specific model type was explicitly requested.",
+ "type": "string"
+ },
+ "translatedText": {
+ "description": "Text translated into the target language.",
+ "type": "string"
+ },
+ "detectedSourceLanguage": {
+ "description": "The source language of the initial request, detected automatically, if\nno source language was passed within the initial request. If the\nsource language was passed, auto-detection of the language will not\noccur and this field will be empty.",
+ "type": "string"
+ }
+ },
+ "id": "TranslationsResource"
+ },
+ "DetectionsResource": {
+ "description": "An array of languages which we detect for the given text The most likely language list first.",
+ "type": "array",
+ "items": {
+ "properties": {
+ "confidence": {
+ "description": "The confidence of the detection result of this language.",
+ "format": "float",
+ "type": "number"
+ },
+ "isReliable": {
+ "description": "A boolean to indicate is the language detection result reliable.",
+ "type": "boolean"
+ },
+ "language": {
+ "description": "The language we detected.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "id": "DetectionsResource"
+ },
+ "TranslationsListResponse": {
+ "properties": {
+ "translations": {
+ "description": "Translations contains list of translation results of given text",
+ "type": "array",
+ "items": {
+ "$ref": "TranslationsResource"
+ }
+ }
+ },
+ "id": "TranslationsListResponse",
+ "description": "The main language translation response message.",
+ "type": "object"
+ },
+ "TranslateTextRequest": {
+ "properties": {
+ "model": {
+ "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
+ "type": "string"
+ },
+ "target": {
+ "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
+ "type": "string"
+ },
+ "q": {
+ "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "format": {
+ "description": "The format of the source text, in either HTML (default) or plain-text. A\nvalue of \"html\" indicates HTML and a value of \"text\" indicates plain-text.",
+ "type": "string"
+ },
+ "source": {
+ "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.",
+ "type": "string"
+ }
+ },
+ "id": "TranslateTextRequest",
+ "description": "The main translation request message for the Cloud Translation API.",
+ "type": "object"
+ },
+ "DetectLanguageRequest": {
+ "description": "The request message for language detection.",
+ "type": "object",
+ "properties": {
+ "q": {
+ "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "DetectLanguageRequest"
}
- }
},
- "translations": {
- "methods": {
- "list": {
- "id": "language.translations.list",
- "path": "v2",
- "httpMethod": "GET",
- "description": "Returns text translations from one language to another.",
- "parameters": {
- "cid": {
- "type": "string",
- "description": "The customization id for translate",
- "repeated": true,
- "location": "query"
- },
- "format": {
- "type": "string",
- "description": "The format of the text",
- "enum": [
- "html",
- "text"
- ],
- "enumDescriptions": [
- "Specifies the input is in HTML",
- "Specifies the input is in plain textual format"
- ],
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "The text to translate",
- "required": true,
- "repeated": true,
- "location": "query"
- },
- "source": {
- "type": "string",
- "description": "The source language of the text",
- "location": "query"
- },
- "target": {
- "type": "string",
- "description": "The target language into which the text should be translated",
- "required": true,
- "location": "query"
+ "icons": {
+ "x32": "https://www.google.com/images/icons/product/translate-32.png",
+ "x16": "https://www.google.com/images/icons/product/translate-16.png"
+ },
+ "protocol": "rest",
+ "canonicalName": "Translate",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-translation": {
+ "description": "Translate text from one language to another using Google Translate"
+ }
}
- },
- "parameterOrder": [
- "q",
- "target"
- ],
- "response": {
- "$ref": "TranslationsListResponse"
- }
}
- }
- }
- }
+ },
+ "rootUrl": "https://translation.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "translate",
+ "batchPath": "batch/translate",
+ "title": "Google Cloud Translation API",
+ "features": [
+ "dataWrapper"
+ ]
}
diff --git a/translate/v2/translate-gen.go b/translate/v2/translate-gen.go
index a3705f9..668343a 100644
--- a/translate/v2/translate-gen.go
+++ b/translate/v2/translate-gen.go
@@ -1,6 +1,6 @@
-// Package translate provides access to the Translate API.
+// Package translate provides access to the Google Cloud Translation API.
//
-// See https://developers.google.com/translate/v2/using_rest
+// See https://code.google.com/apis/language/translate/v2/getting_started.html
//
// Usage example:
//
@@ -43,7 +43,16 @@
const apiId = "translate:v2"
const apiName = "translate"
const apiVersion = "v2"
-const basePath = "https://www.googleapis.com/language/translate/"
+const basePath = "https://translation.googleapis.com/language/translate/"
+
+// 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"
+
+ // Translate text from one language to another using Google Translate
+ CloudTranslationScope = "https://www.googleapis.com/auth/cloud-translation"
+)
func New(client *http.Client) (*Service, error) {
if client == nil {
@@ -102,6 +111,36 @@
s *Service
}
+// DetectLanguageRequest: The request message for language detection.
+type DetectLanguageRequest struct {
+ // Q: The input text upon which to perform language detection. Repeat
+ // this
+ // parameter to perform language detection on multiple text inputs.
+ Q []string `json:"q,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Q") 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. "Q") 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 *DetectLanguageRequest) MarshalJSON() ([]byte, error) {
+ type noMethod DetectLanguageRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type DetectionsListResponse struct {
// Detections: A detections contains detection results of several text
Detections [][]*DetectionsResourceItem `json:"detections,omitempty"`
@@ -134,14 +173,14 @@
}
type DetectionsResourceItem struct {
- // Confidence: The confidence of the detection resul of this language.
+ // Confidence: The confidence of the detection result of this language.
Confidence float64 `json:"confidence,omitempty"`
// IsReliable: A boolean to indicate is the language detection result
// reliable.
IsReliable bool `json:"isReliable,omitempty"`
- // Language: The language we detect
+ // Language: The language we detected.
Language string `json:"language,omitempty"`
// ForceSendFields is a list of field names (e.g. "Confidence") to
@@ -181,6 +220,37 @@
return nil
}
+// GetSupportedLanguagesRequest: The request message for discovering
+// supported languages.
+type GetSupportedLanguagesRequest struct {
+ // Target: The language to use to return localized, human readable names
+ // of supported
+ // languages.
+ Target string `json:"target,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Target") 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. "Target") 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 *GetSupportedLanguagesRequest) MarshalJSON() ([]byte, error) {
+ type noMethod GetSupportedLanguagesRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type LanguagesListResponse struct {
// Languages: List of source/target languages supported by the
// translation API. If target parameter is unspecified, the list is
@@ -217,11 +287,15 @@
}
type LanguagesResource struct {
- // Language: The language code.
+ // Language: Supported language code, generally consisting of its ISO
+ // 639-1
+ // identifier. (E.g. 'en', 'ja'). In certain cases, BCP-47 codes
+ // including
+ // language + region identifiers are returned (e.g. 'zh-TW' and 'zh-CH')
Language string `json:"language,omitempty"`
- // Name: The localized name of the language if target parameter is
- // given.
+ // Name: Human readable name of the language localized to the target
+ // language.
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "Language") to
@@ -247,6 +321,64 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// TranslateTextRequest: The main translation request message for the
+// Cloud Translation API.
+type TranslateTextRequest struct {
+ // Format: The format of the source text, in either HTML (default) or
+ // plain-text. A
+ // value of "html" indicates HTML and a value of "text" indicates
+ // plain-text.
+ Format string `json:"format,omitempty"`
+
+ // Model: The `model` type requested for this translation. Valid values
+ // are
+ // listed in public documentation.
+ Model string `json:"model,omitempty"`
+
+ // Q: The input text to translate. Repeat this parameter to perform
+ // translation
+ // operations on multiple text inputs.
+ Q []string `json:"q,omitempty"`
+
+ // Source: The language of the source text, set to one of the language
+ // codes listed in
+ // Language Support. If the source language is not specified, the API
+ // will
+ // attempt to identify the source language automatically and return it
+ // within
+ // the response.
+ Source string `json:"source,omitempty"`
+
+ // Target: The language to use for translation of the input text, set to
+ // one of the
+ // language codes listed in Language Support.
+ Target string `json:"target,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Format") 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. "Format") 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 *TranslateTextRequest) MarshalJSON() ([]byte, error) {
+ type noMethod TranslateTextRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// TranslationsListResponse: The main language translation response
+// message.
type TranslationsListResponse struct {
// Translations: Translations contains list of translation results of
// given text
@@ -280,11 +412,23 @@
}
type TranslationsResource struct {
- // DetectedSourceLanguage: Detected source language if source parameter
- // is unspecified.
+ // DetectedSourceLanguage: The source language of the initial request,
+ // detected automatically, if
+ // no source language was passed within the initial request. If
+ // the
+ // source language was passed, auto-detection of the language will
+ // not
+ // occur and this field will be empty.
DetectedSourceLanguage string `json:"detectedSourceLanguage,omitempty"`
- // TranslatedText: The translation.
+ // Model: The `model` type used for this translation. Valid values
+ // are
+ // listed in public documentation. Can be different from requested
+ // `model`.
+ // Present only if specific model type was explicitly requested.
+ Model string `json:"model,omitempty"`
+
+ // TranslatedText: Text translated into the target language.
TranslatedText string `json:"translatedText,omitempty"`
// ForceSendFields is a list of field names (e.g.
@@ -312,6 +456,128 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// method id "language.detections.detect":
+
+type DetectionsDetectCall struct {
+ s *Service
+ detectlanguagerequest *DetectLanguageRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Detect: Detects the language of text within a request.
+func (r *DetectionsService) Detect(detectlanguagerequest *DetectLanguageRequest) *DetectionsDetectCall {
+ c := &DetectionsDetectCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.detectlanguagerequest = detectlanguagerequest
+ 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 *DetectionsDetectCall) Fields(s ...googleapi.Field) *DetectionsDetectCall {
+ 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 *DetectionsDetectCall) Context(ctx context.Context) *DetectionsDetectCall {
+ 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 *DetectionsDetectCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *DetectionsDetectCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithDataWrapper.JSONReader(c.detectlanguagerequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/detect")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "language.detections.detect" call.
+// Exactly one of *DetectionsListResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *DetectionsListResponse.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 *DetectionsDetectCall) Do(opts ...googleapi.CallOption) (*DetectionsListResponse, 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 := &DetectionsListResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &struct {
+ Data *DetectionsListResponse `json:"data"`
+ }{ret}
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Detects the language of text within a request.",
+ // "httpMethod": "POST",
+ // "id": "language.detections.detect",
+ // "parameterOrder": [],
+ // "parameters": {},
+ // "path": "v2/detect",
+ // "request": {
+ // "$ref": "DetectLanguageRequest"
+ // },
+ // "response": {
+ // "$ref": "DetectionsListResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-translation",
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
// method id "language.detections.list":
type DetectionsListCall struct {
@@ -322,7 +588,7 @@
header_ http.Header
}
-// List: Detect the language of text.
+// List: Detects the language of text within a request.
func (r *DetectionsService) List(q []string) *DetectionsListCall {
c := &DetectionsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.urlParams_.SetMulti("q", append([]string{}, q...))
@@ -422,7 +688,7 @@
}
return ret, nil
// {
- // "description": "Detect the language of text.",
+ // "description": "Detects the language of text within a request.",
// "httpMethod": "GET",
// "id": "language.detections.list",
// "parameterOrder": [
@@ -430,7 +696,7 @@
// ],
// "parameters": {
// "q": {
- // "description": "The text to detect",
+ // "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
// "location": "query",
// "repeated": true,
// "required": true,
@@ -440,7 +706,11 @@
// "path": "v2/detect",
// "response": {
// "$ref": "DetectionsListResponse"
- // }
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-translation",
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
// }
}
@@ -455,14 +725,22 @@
header_ http.Header
}
-// List: List the source/target languages supported by the API
+// List: Returns a list of supported languages for translation.
func (r *LanguagesService) List() *LanguagesListCall {
c := &LanguagesListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
return c
}
-// Target sets the optional parameter "target": the language and
-// collation in which the localized results should be returned
+// Model sets the optional parameter "model": The model type for which
+// supported languages should be returned.
+func (c *LanguagesListCall) Model(model string) *LanguagesListCall {
+ c.urlParams_.Set("model", model)
+ return c
+}
+
+// Target sets the optional parameter "target": The language to use to
+// return localized, human readable names of supported
+// languages.
func (c *LanguagesListCall) Target(target string) *LanguagesListCall {
c.urlParams_.Set("target", target)
return c
@@ -561,12 +839,17 @@
}
return ret, nil
// {
- // "description": "List the source/target languages supported by the API",
+ // "description": "Returns a list of supported languages for translation.",
// "httpMethod": "GET",
// "id": "language.languages.list",
// "parameters": {
+ // "model": {
+ // "description": "The model type for which supported languages should be returned.",
+ // "location": "query",
+ // "type": "string"
+ // },
// "target": {
- // "description": "the language and collation in which the localized results should be returned",
+ // "description": "The language to use to return localized, human readable names of supported\nlanguages.",
// "location": "query",
// "type": "string"
// }
@@ -574,7 +857,11 @@
// "path": "v2/languages",
// "response": {
// "$ref": "LanguagesListResponse"
- // }
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-translation",
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
// }
}
@@ -589,7 +876,7 @@
header_ http.Header
}
-// List: Returns text translations from one language to another.
+// List: Translates input text, returning translated text.
func (r *TranslationsService) List(q []string, target string) *TranslationsListCall {
c := &TranslationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.urlParams_.SetMulti("q", append([]string{}, q...))
@@ -604,7 +891,10 @@
return c
}
-// Format sets the optional parameter "format": The format of the text
+// Format sets the optional parameter "format": The format of the source
+// text, in either HTML (default) or plain-text. A
+// value of "html" indicates HTML and a value of "text" indicates
+// plain-text.
//
// Possible values:
// "html" - Specifies the input is in HTML
@@ -614,8 +904,21 @@
return c
}
-// Source sets the optional parameter "source": The source language of
-// the text
+// Model sets the optional parameter "model": The `model` type requested
+// for this translation. Valid values are
+// listed in public documentation.
+func (c *TranslationsListCall) Model(model string) *TranslationsListCall {
+ c.urlParams_.Set("model", model)
+ return c
+}
+
+// Source sets the optional parameter "source": The language of the
+// source text, set to one of the language codes listed in
+// Language Support. If the source language is not specified, the API
+// will
+// attempt to identify the source language automatically and return it
+// within
+// the response.
func (c *TranslationsListCall) Source(source string) *TranslationsListCall {
c.urlParams_.Set("source", source)
return c
@@ -714,7 +1017,7 @@
}
return ret, nil
// {
- // "description": "Returns text translations from one language to another.",
+ // "description": "Translates input text, returning translated text.",
// "httpMethod": "GET",
// "id": "language.translations.list",
// "parameterOrder": [
@@ -729,7 +1032,7 @@
// "type": "string"
// },
// "format": {
- // "description": "The format of the text",
+ // "description": "The format of the source text, in either HTML (default) or plain-text. A\nvalue of \"html\" indicates HTML and a value of \"text\" indicates plain-text.",
// "enum": [
// "html",
// "text"
@@ -741,20 +1044,25 @@
// "location": "query",
// "type": "string"
// },
+ // "model": {
+ // "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
+ // "location": "query",
+ // "type": "string"
+ // },
// "q": {
- // "description": "The text to translate",
+ // "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
// "location": "query",
// "repeated": true,
// "required": true,
// "type": "string"
// },
// "source": {
- // "description": "The source language of the text",
+ // "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.",
// "location": "query",
// "type": "string"
// },
// "target": {
- // "description": "The target language into which the text should be translated",
+ // "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
// "location": "query",
// "required": true,
// "type": "string"
@@ -763,7 +1071,133 @@
// "path": "v2",
// "response": {
// "$ref": "TranslationsListResponse"
- // }
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-translation",
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "language.translations.translate":
+
+type TranslationsTranslateCall struct {
+ s *Service
+ translatetextrequest *TranslateTextRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Translate: Translates input text, returning translated text.
+func (r *TranslationsService) Translate(translatetextrequest *TranslateTextRequest) *TranslationsTranslateCall {
+ c := &TranslationsTranslateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.translatetextrequest = translatetextrequest
+ 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 *TranslationsTranslateCall) Fields(s ...googleapi.Field) *TranslationsTranslateCall {
+ 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 *TranslationsTranslateCall) Context(ctx context.Context) *TranslationsTranslateCall {
+ 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 *TranslationsTranslateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *TranslationsTranslateCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithDataWrapper.JSONReader(c.translatetextrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "language.translations.translate" call.
+// Exactly one of *TranslationsListResponse or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *TranslationsListResponse.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 *TranslationsTranslateCall) Do(opts ...googleapi.CallOption) (*TranslationsListResponse, 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 := &TranslationsListResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &struct {
+ Data *TranslationsListResponse `json:"data"`
+ }{ret}
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Translates input text, returning translated text.",
+ // "httpMethod": "POST",
+ // "id": "language.translations.translate",
+ // "parameterOrder": [],
+ // "parameters": {},
+ // "path": "v2",
+ // "request": {
+ // "$ref": "TranslateTextRequest"
+ // },
+ // "response": {
+ // "$ref": "TranslationsListResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-translation",
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
// }
}
diff --git a/videointelligence/v1beta1/videointelligence-api.json b/videointelligence/v1beta1/videointelligence-api.json
new file mode 100644
index 0000000..457d3cd
--- /dev/null
+++ b/videointelligence/v1beta1/videointelligence-api.json
@@ -0,0 +1,448 @@
+{
+ "ownerName": "Google",
+ "resources": {
+ "videos": {
+ "methods": {
+ "annotate": {
+ "response": {
+ "$ref": "GoogleLongrunning_Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/videos:annotate",
+ "path": "v1beta1/videos:annotate",
+ "id": "videointelligence.videos.annotate",
+ "request": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
+ },
+ "description": "Performs asynchronous video annotation. Progress and results can be\nretrieved through the `google.longrunning.Operations` interface.\n`Operation.metadata` contains `AnnotateVideoProgress` (progress).\n`Operation.response` contains `AnnotateVideoResponse` (results)."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://videointelligence.googleapis.com/",
+ "servicePath": "",
+ "description": "Google Cloud Video Intelligence API.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "documentationLink": "https://cloud.google.com/video-intelligence/docs/",
+ "revision": "20170511",
+ "id": "videointelligence:v1beta1",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "schemas": {
+ "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress": {
+ "properties": {
+ "annotationProgress": {
+ "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress"
+ }
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress",
+ "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
+ "type": "object"
+ },
+ "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest": {
+ "description": "Video annotation request.",
+ "type": "object",
+ "properties": {
+ "features": {
+ "description": "Requested video annotation features.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "FEATURE_UNSPECIFIED",
+ "LABEL_DETECTION",
+ "SHOT_CHANGE_DETECTION"
+ ]
+ },
+ "enumDescriptions": [
+ "Unspecified.",
+ "Label detection. Detect objects, such as dog or flower.",
+ "Shot change detection."
+ ]
+ },
+ "outputUri": {
+ "description": "Optional location where the output (in JSON format) should be stored.\nCurrently, only [Google Cloud Storage](https://cloud.google.com/storage/)\nURIs are supported, which must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](/storage/docs/reference-uris).",
+ "type": "string"
+ },
+ "videoContext": {
+ "description": "Additional video context and/or feature-specific parameters.",
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoContext"
+ },
+ "locationId": {
+ "description": "Optional cloud region where annotation should take place. Supported cloud\nregions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region\nis specified, a region will be determined based on video file location.",
+ "type": "string"
+ },
+ "inputUri": {
+ "description": "Input video location. Currently, only\n[Google Cloud Storage](https://cloud.google.com/storage/) URIs are\nsupported, which must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](/storage/docs/reference-uris).\nA video URI may include wildcards in `object-id`, and thus identify\nmultiple videos. Supported wildcards: '*' to match 0 or more characters;\n'?' to match 1 character. If unset, the input video should be embedded\nin the request as `input_content`. If set, `input_content` should be unset.",
+ "type": "string"
+ },
+ "inputContent": {
+ "description": "The video data bytes. Encoding: base64. If unset, the input video(s)\nshould be specified via `input_uri`. If set, `input_uri` should be unset.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
+ },
+ "GoogleCloudVideointelligenceV1beta1_LabelLocation": {
+ "description": "Label location.",
+ "type": "object",
+ "properties": {
+ "segment": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment",
+ "description": "Video segment. Set to [-1, -1] for video-level labels.\nSet to [timestamp, timestamp] for frame-level labels.\nOtherwise, corresponds to one of `AnnotateSpec.segments`\n(if specified) or to shot boundaries (if requested)."
+ },
+ "level": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Video-level. Corresponds to the whole video.",
+ "Segment-level. Corresponds to one of `AnnotateSpec.segments`.",
+ "Shot-level. Corresponds to a single shot (i.e. a series of frames\nwithout a major camera position or background change).",
+ "Frame-level. Corresponds to a single video frame."
+ ],
+ "enum": [
+ "LABEL_LEVEL_UNSPECIFIED",
+ "VIDEO_LEVEL",
+ "SEGMENT_LEVEL",
+ "SHOT_LEVEL",
+ "FRAME_LEVEL"
+ ],
+ "description": "Label level.",
+ "type": "string"
+ },
+ "confidence": {
+ "description": "Confidence that the label is accurate. Range: [0, 1].",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
+ },
+ "GoogleCloudVideointelligenceV1beta1_VideoSegment": {
+ "properties": {
+ "endTimeOffset": {
+ "description": "End offset in microseconds (inclusive). Unset means 0.",
+ "format": "int64",
+ "type": "string"
+ },
+ "startTimeOffset": {
+ "description": "Start offset in microseconds (inclusive). Unset means 0.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoSegment",
+ "description": "Video segment.",
+ "type": "object"
+ },
+ "GoogleLongrunning_Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "GoogleRpc_Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "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"
+ },
+ "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults": {
+ "description": "Annotation results for a single video.",
+ "type": "object",
+ "properties": {
+ "labelAnnotations": {
+ "description": "Label annotations. There is exactly one element for each unique label.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation"
+ }
+ },
+ "error": {
+ "$ref": "GoogleRpc_Status",
+ "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail."
+ },
+ "shotAnnotations": {
+ "description": "Shot annotations. Each shot is represented as a video segment.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
+ }
+ },
+ "inputUri": {
+ "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults"
+ },
+ "GoogleCloudVideointelligenceV1beta1_LabelAnnotation": {
+ "properties": {
+ "locations": {
+ "description": "Where the label was detected and with what confidence.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
+ }
+ },
+ "languageCode": {
+ "description": "Language code for `description` in BCP-47 format.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Textual description, e.g. `Fixed-gear bicycle`.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation",
+ "description": "Label annotation.",
+ "type": "object"
+ },
+ "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse": {
+ "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
+ "type": "object",
+ "properties": {
+ "annotationResults": {
+ "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults"
+ }
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse"
+ },
+ "GoogleCloudVideointelligenceV1beta1_VideoContext": {
+ "description": "Video context and/or feature-specific parameters.",
+ "type": "object",
+ "properties": {
+ "labelDetectionModel": {
+ "description": "Model to use for label detection.\nSupported values: \"latest\" and \"stable\" (the default).",
+ "type": "string"
+ },
+ "labelDetectionMode": {
+ "description": "If label detection has been requested, what labels should be detected\nin addition to video-level labels or segment-level labels. If unspecified,\ndefaults to `SHOT_MODE`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Detect shot-level labels.",
+ "Detect frame-level labels.",
+ "Detect both shot-level and frame-level labels."
+ ],
+ "enum": [
+ "LABEL_DETECTION_MODE_UNSPECIFIED",
+ "SHOT_MODE",
+ "FRAME_MODE",
+ "SHOT_AND_FRAME_MODE"
+ ]
+ },
+ "shotChangeDetectionModel": {
+ "description": "Model to use for shot change detection.\nSupported values: \"latest\" and \"stable\" (the default).",
+ "type": "string"
+ },
+ "segments": {
+ "description": "Video segments to annotate. The segments may overlap and are not required\nto be contiguous or span the whole video. If unspecified, each video\nis treated as a single segment.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
+ }
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoContext"
+ },
+ "GoogleRpc_Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "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": "GoogleRpc_Status"
+ },
+ "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress": {
+ "description": "Annotation progress for a single video.",
+ "type": "object",
+ "properties": {
+ "updateTime": {
+ "description": "Time of the most recent update.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Time when the request was received.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "inputUri": {
+ "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
+ "type": "string"
+ },
+ "progressPercent": {
+ "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress"
+ }
+ },
+ "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 Video Intelligence",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://videointelligence.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "videointelligence",
+ "batchPath": "batch",
+ "title": "Google Cloud Video Intelligence API"
+}
diff --git a/videointelligence/v1beta1/videointelligence-gen.go b/videointelligence/v1beta1/videointelligence-gen.go
new file mode 100644
index 0000000..114f65e
--- /dev/null
+++ b/videointelligence/v1beta1/videointelligence-gen.go
@@ -0,0 +1,823 @@
+// Package videointelligence provides access to the Google Cloud Video Intelligence API.
+//
+// See https://cloud.google.com/video-intelligence/docs/
+//
+// Usage example:
+//
+// import "google.golang.org/api/videointelligence/v1beta1"
+// ...
+// videointelligenceService, err := videointelligence.New(oauthHttpClient)
+package videointelligence // import "google.golang.org/api/videointelligence/v1beta1"
+
+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 = "videointelligence:v1beta1"
+const apiName = "videointelligence"
+const apiVersion = "v1beta1"
+const basePath = "https://videointelligence.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.Videos = NewVideosService(s)
+ return s, nil
+}
+
+type Service struct {
+ client *http.Client
+ BasePath string // API endpoint base URL
+ UserAgent string // optional additional User-Agent fragment
+
+ Videos *VideosService
+}
+
+func (s *Service) userAgent() string {
+ if s.UserAgent == "" {
+ return googleapi.UserAgent
+ }
+ return googleapi.UserAgent + " " + s.UserAgent
+}
+
+func NewVideosService(s *Service) *VideosService {
+ rs := &VideosService{s: s}
+ return rs
+}
+
+type VideosService struct {
+ s *Service
+}
+
+// GoogleCloudVideointelligenceV1beta1AnnotateVideoProgress: Video
+// annotation progress. Included in the `metadata`
+// field of the `Operation` returned by the `GetOperation`
+// call of the `google::longrunning::Operations` service.
+type GoogleCloudVideointelligenceV1beta1AnnotateVideoProgress struct {
+ // AnnotationProgress: Progress metadata for all videos specified in
+ // `AnnotateVideoRequest`.
+ AnnotationProgress []*GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress `json:"annotationProgress,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AnnotationProgress")
+ // 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. "AnnotationProgress") 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 *GoogleCloudVideointelligenceV1beta1AnnotateVideoProgress) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudVideointelligenceV1beta1AnnotateVideoProgress
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest: Video
+// annotation request.
+type GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest struct {
+ // Features: Requested video annotation features.
+ //
+ // Possible values:
+ // "FEATURE_UNSPECIFIED" - Unspecified.
+ // "LABEL_DETECTION" - Label detection. Detect objects, such as dog or
+ // flower.
+ // "SHOT_CHANGE_DETECTION" - Shot change detection.
+ Features []string `json:"features,omitempty"`
+
+ // InputContent: The video data bytes. Encoding: base64. If unset, the
+ // input video(s)
+ // should be specified via `input_uri`. If set, `input_uri` should be
+ // unset.
+ InputContent string `json:"inputContent,omitempty"`
+
+ // InputUri: Input video location. Currently, only
+ // [Google Cloud Storage](https://cloud.google.com/storage/) URIs
+ // are
+ // supported, which must be specified in the following
+ // format:
+ // `gs://bucket-id/object-id` (other URI formats
+ // return
+ // google.rpc.Code.INVALID_ARGUMENT). For more information, see
+ // [Request URIs](/storage/docs/reference-uris).
+ // A video URI may include wildcards in `object-id`, and thus
+ // identify
+ // multiple videos. Supported wildcards: '*' to match 0 or more
+ // characters;
+ // '?' to match 1 character. If unset, the input video should be
+ // embedded
+ // in the request as `input_content`. If set, `input_content` should be
+ // unset.
+ InputUri string `json:"inputUri,omitempty"`
+
+ // LocationId: Optional cloud region where annotation should take place.
+ // Supported cloud
+ // regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no
+ // region
+ // is specified, a region will be determined based on video file
+ // location.
+ LocationId string `json:"locationId,omitempty"`
+
+ // OutputUri: Optional location where the output (in JSON format) should
+ // be stored.
+ // Currently, only [Google Cloud
+ // Storage](https://cloud.google.com/storage/)
+ // URIs are supported, which must be specified in the following
+ // format:
+ // `gs://bucket-id/object-id` (other URI formats
+ // return
+ // google.rpc.Code.INVALID_ARGUMENT). For more information, see
+ // [Request URIs](/storage/docs/reference-uris).
+ OutputUri string `json:"outputUri,omitempty"`
+
+ // VideoContext: Additional video context and/or feature-specific
+ // parameters.
+ VideoContext *GoogleCloudVideointelligenceV1beta1VideoContext `json:"videoContext,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Features") 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. "Features") 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 *GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudVideointelligenceV1beta1AnnotateVideoResponse: Video
+// annotation response. Included in the `response`
+// field of the `Operation` returned by the `GetOperation`
+// call of the `google::longrunning::Operations` service.
+type GoogleCloudVideointelligenceV1beta1AnnotateVideoResponse struct {
+ // AnnotationResults: Annotation results for all videos specified in
+ // `AnnotateVideoRequest`.
+ AnnotationResults []*GoogleCloudVideointelligenceV1beta1VideoAnnotationResults `json:"annotationResults,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AnnotationResults")
+ // 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. "AnnotationResults") 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 *GoogleCloudVideointelligenceV1beta1AnnotateVideoResponse) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudVideointelligenceV1beta1AnnotateVideoResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudVideointelligenceV1beta1LabelAnnotation: Label annotation.
+type GoogleCloudVideointelligenceV1beta1LabelAnnotation struct {
+ // Description: Textual description, e.g. `Fixed-gear bicycle`.
+ Description string `json:"description,omitempty"`
+
+ // LanguageCode: Language code for `description` in BCP-47 format.
+ LanguageCode string `json:"languageCode,omitempty"`
+
+ // Locations: Where the label was detected and with what confidence.
+ Locations []*GoogleCloudVideointelligenceV1beta1LabelLocation `json:"locations,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 *GoogleCloudVideointelligenceV1beta1LabelAnnotation) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudVideointelligenceV1beta1LabelAnnotation
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudVideointelligenceV1beta1LabelLocation: Label location.
+type GoogleCloudVideointelligenceV1beta1LabelLocation struct {
+ // Confidence: Confidence that the label is accurate. Range: [0, 1].
+ Confidence float64 `json:"confidence,omitempty"`
+
+ // Level: Label level.
+ //
+ // Possible values:
+ // "LABEL_LEVEL_UNSPECIFIED" - Unspecified.
+ // "VIDEO_LEVEL" - Video-level. Corresponds to the whole video.
+ // "SEGMENT_LEVEL" - Segment-level. Corresponds to one of
+ // `AnnotateSpec.segments`.
+ // "SHOT_LEVEL" - Shot-level. Corresponds to a single shot (i.e. a
+ // series of frames
+ // without a major camera position or background change).
+ // "FRAME_LEVEL" - Frame-level. Corresponds to a single video frame.
+ Level string `json:"level,omitempty"`
+
+ // Segment: Video segment. Set to [-1, -1] for video-level labels.
+ // Set to [timestamp, timestamp] for frame-level labels.
+ // Otherwise, corresponds to one of `AnnotateSpec.segments`
+ // (if specified) or to shot boundaries (if requested).
+ Segment *GoogleCloudVideointelligenceV1beta1VideoSegment `json:"segment,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Confidence") 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. "Confidence") 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 *GoogleCloudVideointelligenceV1beta1LabelLocation) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudVideointelligenceV1beta1LabelLocation
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+func (s *GoogleCloudVideointelligenceV1beta1LabelLocation) UnmarshalJSON(data []byte) error {
+ type noMethod GoogleCloudVideointelligenceV1beta1LabelLocation
+ var s1 struct {
+ Confidence gensupport.JSONFloat64 `json:"confidence"`
+ *noMethod
+ }
+ s1.noMethod = (*noMethod)(s)
+ if err := json.Unmarshal(data, &s1); err != nil {
+ return err
+ }
+ s.Confidence = float64(s1.Confidence)
+ return nil
+}
+
+// GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress:
+// Annotation progress for a single video.
+type GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress struct {
+ // InputUri: Video file location in
+ // [Google Cloud Storage](https://cloud.google.com/storage/).
+ InputUri string `json:"inputUri,omitempty"`
+
+ // ProgressPercent: Approximate percentage processed thus
+ // far.
+ // Guaranteed to be 100 when fully processed.
+ ProgressPercent int64 `json:"progressPercent,omitempty"`
+
+ // StartTime: Time when the request was received.
+ StartTime string `json:"startTime,omitempty"`
+
+ // UpdateTime: Time of the most recent update.
+ UpdateTime string `json:"updateTime,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "InputUri") 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. "InputUri") 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 *GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudVideointelligenceV1beta1VideoAnnotationProgress
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudVideointelligenceV1beta1VideoAnnotationResults: Annotation
+// results for a single video.
+type GoogleCloudVideointelligenceV1beta1VideoAnnotationResults struct {
+ // Error: If set, indicates an error. Note that for a single
+ // `AnnotateVideoRequest`
+ // some videos may succeed and some may fail.
+ Error *GoogleRpcStatus `json:"error,omitempty"`
+
+ // InputUri: Video file location in
+ // [Google Cloud Storage](https://cloud.google.com/storage/).
+ InputUri string `json:"inputUri,omitempty"`
+
+ // LabelAnnotations: Label annotations. There is exactly one element for
+ // each unique label.
+ LabelAnnotations []*GoogleCloudVideointelligenceV1beta1LabelAnnotation `json:"labelAnnotations,omitempty"`
+
+ // ShotAnnotations: Shot annotations. Each shot is represented as a
+ // video segment.
+ ShotAnnotations []*GoogleCloudVideointelligenceV1beta1VideoSegment `json:"shotAnnotations,omitempty"`
+
+ // 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 *GoogleCloudVideointelligenceV1beta1VideoAnnotationResults) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudVideointelligenceV1beta1VideoAnnotationResults
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudVideointelligenceV1beta1VideoContext: Video context and/or
+// feature-specific parameters.
+type GoogleCloudVideointelligenceV1beta1VideoContext struct {
+ // LabelDetectionMode: If label detection has been requested, what
+ // labels should be detected
+ // in addition to video-level labels or segment-level labels. If
+ // unspecified,
+ // defaults to `SHOT_MODE`.
+ //
+ // Possible values:
+ // "LABEL_DETECTION_MODE_UNSPECIFIED" - Unspecified.
+ // "SHOT_MODE" - Detect shot-level labels.
+ // "FRAME_MODE" - Detect frame-level labels.
+ // "SHOT_AND_FRAME_MODE" - Detect both shot-level and frame-level
+ // labels.
+ LabelDetectionMode string `json:"labelDetectionMode,omitempty"`
+
+ // LabelDetectionModel: Model to use for label detection.
+ // Supported values: "latest" and "stable" (the default).
+ LabelDetectionModel string `json:"labelDetectionModel,omitempty"`
+
+ // Segments: Video segments to annotate. The segments may overlap and
+ // are not required
+ // to be contiguous or span the whole video. If unspecified, each
+ // video
+ // is treated as a single segment.
+ Segments []*GoogleCloudVideointelligenceV1beta1VideoSegment `json:"segments,omitempty"`
+
+ // ShotChangeDetectionModel: Model to use for shot change
+ // detection.
+ // Supported values: "latest" and "stable" (the default).
+ ShotChangeDetectionModel string `json:"shotChangeDetectionModel,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "LabelDetectionMode")
+ // 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. "LabelDetectionMode") 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 *GoogleCloudVideointelligenceV1beta1VideoContext) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudVideointelligenceV1beta1VideoContext
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudVideointelligenceV1beta1VideoSegment: Video segment.
+type GoogleCloudVideointelligenceV1beta1VideoSegment struct {
+ // EndTimeOffset: End offset in microseconds (inclusive). Unset means 0.
+ EndTimeOffset int64 `json:"endTimeOffset,omitempty,string"`
+
+ // StartTimeOffset: Start offset in microseconds (inclusive). Unset
+ // means 0.
+ StartTimeOffset int64 `json:"startTimeOffset,omitempty,string"`
+
+ // ForceSendFields is a list of field names (e.g. "EndTimeOffset") 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. "EndTimeOffset") 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 *GoogleCloudVideointelligenceV1beta1VideoSegment) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudVideointelligenceV1beta1VideoSegment
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleLongrunningOperation: This resource represents a long-running
+// operation that is the result of a
+// network API call.
+type GoogleLongrunningOperation 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 *GoogleRpcStatus `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 *GoogleLongrunningOperation) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleLongrunningOperation
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleRpcStatus: 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` that 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.
+//
+// - 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 GoogleRpcStatus 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 *GoogleRpcStatus) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleRpcStatus
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// method id "videointelligence.videos.annotate":
+
+type VideosAnnotateCall struct {
+ s *Service
+ googlecloudvideointelligencev1beta1Annotatevideorequest *GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Annotate: Performs asynchronous video annotation. Progress and
+// results can be
+// retrieved through the `google.longrunning.Operations`
+// interface.
+// `Operation.metadata` contains `AnnotateVideoProgress`
+// (progress).
+// `Operation.response` contains `AnnotateVideoResponse` (results).
+func (r *VideosService) Annotate(googlecloudvideointelligencev1beta1Annotatevideorequest *GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest) *VideosAnnotateCall {
+ c := &VideosAnnotateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.googlecloudvideointelligencev1beta1Annotatevideorequest = googlecloudvideointelligencev1beta1Annotatevideorequest
+ 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 *VideosAnnotateCall) Fields(s ...googleapi.Field) *VideosAnnotateCall {
+ 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 *VideosAnnotateCall) Context(ctx context.Context) *VideosAnnotateCall {
+ 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 *VideosAnnotateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *VideosAnnotateCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.googlecloudvideointelligencev1beta1Annotatevideorequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/videos:annotate")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "videointelligence.videos.annotate" call.
+// Exactly one of *GoogleLongrunningOperation or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *GoogleLongrunningOperation.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 *VideosAnnotateCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, 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 := &GoogleLongrunningOperation{
+ 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 asynchronous video annotation. Progress and results can be\nretrieved through the `google.longrunning.Operations` interface.\n`Operation.metadata` contains `AnnotateVideoProgress` (progress).\n`Operation.response` contains `AnnotateVideoResponse` (results).",
+ // "flatPath": "v1beta1/videos:annotate",
+ // "httpMethod": "POST",
+ // "id": "videointelligence.videos.annotate",
+ // "parameterOrder": [],
+ // "parameters": {},
+ // "path": "v1beta1/videos:annotate",
+ // "request": {
+ // "$ref": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
+ // },
+ // "response": {
+ // "$ref": "GoogleLongrunning_Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
diff --git a/vision/v1/vision-api.json b/vision/v1/vision-api.json
index 8a00c34..6effcc5 100644
--- a/vision/v1/vision-api.json
+++ b/vision/v1/vision-api.json
@@ -1,154 +1,208 @@
{
- "canonicalName": "Vision",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://vision.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "vision",
- "batchPath": "batch",
- "title": "Google Cloud Vision API",
- "ownerName": "Google",
- "resources": {
- "images": {
- "methods": {
- "annotate": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "BatchAnnotateImagesResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/images:annotate",
- "id": "vision.images.annotate",
- "path": "v1/images:annotate",
- "request": {
- "$ref": "BatchAnnotateImagesRequest"
- },
- "description": "Run image detection and annotation for a batch of images."
- }
- }
- }
- },
- "parameters": {
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "version": "v1",
- "baseUrl": "https://vision.googleapis.com/",
- "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "basePath": "",
- "id": "vision:v1",
- "revision": "20170501",
- "documentationLink": "https://cloud.google.com/vision/",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "ImageProperties": {
- "description": "Stores image properties, such as dominant colors.",
+ "ImageContext": {
+ "description": "Image context and/or feature-specific parameters.",
"type": "object",
"properties": {
- "dominantColors": {
- "description": "If present, dominant colors completed successfully.",
- "$ref": "DominantColorsAnnotation"
+ "languageHints": {
+ "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](/vision/docs/languages).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "latLongRect": {
+ "$ref": "LatLongRect",
+ "description": "lat/long rectangle that specifies the location of the image."
+ },
+ "cropHintsParams": {
+ "description": "Parameters for crop hints annotation request.",
+ "$ref": "CropHintsParams"
}
},
- "id": "ImageProperties"
+ "id": "ImageContext"
+ },
+ "Page": {
+ "description": "Detected page from OCR.",
+ "type": "object",
+ "properties": {
+ "width": {
+ "description": "Page width in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "blocks": {
+ "description": "List of blocks of text, images etc on this page.",
+ "type": "array",
+ "items": {
+ "$ref": "Block"
+ }
+ },
+ "property": {
+ "description": "Additional information detected on the page.",
+ "$ref": "TextProperty"
+ },
+ "height": {
+ "description": "Page height in pixels.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Page"
+ },
+ "AnnotateImageRequest": {
+ "properties": {
+ "image": {
+ "$ref": "Image",
+ "description": "The image to be processed."
+ },
+ "features": {
+ "description": "Requested features.",
+ "type": "array",
+ "items": {
+ "$ref": "Feature"
+ }
+ },
+ "imageContext": {
+ "description": "Additional context that may accompany the image.",
+ "$ref": "ImageContext"
+ }
+ },
+ "id": "AnnotateImageRequest",
+ "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There 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"
+ },
+ "LatLongRect": {
+ "description": "Rectangle determined by min and max `LatLng` pairs.",
+ "type": "object",
+ "properties": {
+ "minLatLng": {
+ "$ref": "LatLng",
+ "description": "Min lat/long pair."
+ },
+ "maxLatLng": {
+ "description": "Max lat/long pair.",
+ "$ref": "LatLng"
+ }
+ },
+ "id": "LatLongRect"
+ },
+ "Symbol": {
+ "description": "A single symbol representation.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "TextProperty",
+ "description": "Additional information detected for the symbol."
+ },
+ "boundingBox": {
+ "$ref": "BoundingPoly",
+ "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
+ },
+ "text": {
+ "description": "The actual UTF-8 representation of the symbol.",
+ "type": "string"
+ }
+ },
+ "id": "Symbol"
+ },
+ "CropHintsAnnotation": {
+ "description": "Set of crop hints that are used to generate new crops when serving images.",
+ "type": "object",
+ "properties": {
+ "cropHints": {
+ "description": "Crop hint results.",
+ "type": "array",
+ "items": {
+ "$ref": "CropHint"
+ }
+ }
+ },
+ "id": "CropHintsAnnotation"
+ },
+ "LatLng": {
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object",
+ "properties": {
+ "latitude": {
+ "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"
+ },
+ "Color": {
+ "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
+ "type": "object",
+ "properties": {
+ "red": {
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "green": {
+ "description": "The amount of green in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "blue": {
+ "description": "The amount of blue in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "alpha": {
+ "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "Color"
+ },
+ "ImageProperties": {
+ "properties": {
+ "dominantColors": {
+ "$ref": "DominantColorsAnnotation",
+ "description": "If present, dominant colors completed successfully."
+ }
+ },
+ "id": "ImageProperties",
+ "description": "Stores image properties, such as dominant colors.",
+ "type": "object"
},
"Feature": {
"description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.",
@@ -193,12 +247,8 @@
"id": "Feature"
},
"SafeSearchAnnotation": {
- "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).",
- "type": "object",
"properties": {
"spoof": {
- "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.",
@@ -214,7 +264,9 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ]
+ ],
+ "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
+ "type": "string"
},
"medical": {
"enum": [
@@ -237,8 +289,6 @@
]
},
"violence": {
- "description": "Violence likelihood.",
- "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -254,7 +304,9 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ]
+ ],
+ "description": "Violence likelihood.",
+ "type": "string"
},
"adult": {
"enumDescriptions": [
@@ -277,9 +329,13 @@
"type": "string"
}
},
- "id": "SafeSearchAnnotation"
+ "id": "SafeSearchAnnotation",
+ "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).",
+ "type": "object"
},
"DominantColorsAnnotation": {
+ "description": "Set of dominant colors and their corresponding scores.",
+ "type": "object",
"properties": {
"colors": {
"description": "RGB color values with their score and pixel fraction.",
@@ -289,9 +345,7 @@
}
}
},
- "id": "DominantColorsAnnotation",
- "description": "Set of dominant colors and their corresponding scores.",
- "type": "object"
+ "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.",
@@ -311,22 +365,6 @@
},
"id": "TextAnnotation"
},
- "DetectedLanguage": {
- "properties": {
- "languageCode": {
- "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
- "type": "string"
- },
- "confidence": {
- "description": "Confidence of detected language. Range [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "id": "DetectedLanguage",
- "description": "Detected language for a structural component.",
- "type": "object"
- },
"Vertex": {
"description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
"type": "object",
@@ -344,6 +382,22 @@
},
"id": "Vertex"
},
+ "DetectedLanguage": {
+ "properties": {
+ "languageCode": {
+ "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
+ "type": "string"
+ },
+ "confidence": {
+ "description": "Confidence of detected language. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "DetectedLanguage",
+ "description": "Detected language for a structural component.",
+ "type": "object"
+ },
"WebEntity": {
"description": "Entity deduced from similar images on the Internet.",
"type": "object",
@@ -379,29 +433,27 @@
"id": "BoundingPoly"
},
"TextProperty": {
- "description": "Additional information detected on the structural component.",
- "type": "object",
"properties": {
+ "detectedBreak": {
+ "description": "Detected start or end of a text segment.",
+ "$ref": "DetectedBreak"
+ },
"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"
+ "id": "TextProperty",
+ "description": "Additional information detected on the structural component.",
+ "type": "object"
},
"AnnotateImageResponse": {
+ "description": "Response to an image annotation request.",
+ "type": "object",
"properties": {
- "fullTextAnnotation": {
- "$ref": "TextAnnotation",
- "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext."
- },
"landmarkAnnotations": {
"description": "If present, landmark detection has completed successfully.",
"type": "array",
@@ -416,10 +468,6 @@
"$ref": "EntityAnnotation"
}
},
- "imagePropertiesAnnotation": {
- "$ref": "ImageProperties",
- "description": "If present, image properties were extracted successfully."
- },
"faceAnnotations": {
"description": "If present, face detection has completed successfully.",
"type": "array",
@@ -427,6 +475,10 @@
"$ref": "FaceAnnotation"
}
},
+ "imagePropertiesAnnotation": {
+ "$ref": "ImageProperties",
+ "description": "If present, image properties were extracted successfully."
+ },
"logoAnnotations": {
"description": "If present, logo detection has completed successfully.",
"type": "array",
@@ -434,13 +486,17 @@
"$ref": "EntityAnnotation"
}
},
+ "webDetection": {
+ "description": "If present, web detection has completed successfully.",
+ "$ref": "WebDetection"
+ },
"cropHintsAnnotation": {
"$ref": "CropHintsAnnotation",
"description": "If present, crop hints have completed successfully."
},
- "webDetection": {
- "$ref": "WebDetection",
- "description": "If present, web detection has completed successfully."
+ "safeSearchAnnotation": {
+ "description": "If present, safe-search annotation has completed successfully.",
+ "$ref": "SafeSearchAnnotation"
},
"labelAnnotations": {
"description": "If present, label detection has completed successfully.",
@@ -449,22 +505,18 @@
"$ref": "EntityAnnotation"
}
},
- "safeSearchAnnotation": {
- "description": "If present, safe-search annotation has completed successfully.",
- "$ref": "SafeSearchAnnotation"
- },
"error": {
"description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set.",
"$ref": "Status"
+ },
+ "fullTextAnnotation": {
+ "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext.",
+ "$ref": "TextAnnotation"
}
},
- "id": "AnnotateImageResponse",
- "description": "Response to an image annotation request.",
- "type": "object"
+ "id": "AnnotateImageResponse"
},
"CropHintsParams": {
- "description": "Parameters for crop hints annotation request.",
- "type": "object",
"properties": {
"aspectRatios": {
"description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.",
@@ -475,15 +527,15 @@
}
}
},
- "id": "CropHintsParams"
+ "id": "CropHintsParams",
+ "description": "Parameters for crop hints annotation request.",
+ "type": "object"
},
"Block": {
- "description": "Logical element on the page.",
- "type": "object",
"properties": {
"property": {
- "$ref": "TextProperty",
- "description": "Additional information detected for the block."
+ "description": "Additional information detected for the block.",
+ "$ref": "TextProperty"
},
"blockType": {
"enumDescriptions": [
@@ -517,7 +569,35 @@
}
}
},
- "id": "Block"
+ "id": "Block",
+ "description": "Logical element on the page.",
+ "type": "object"
+ },
+ "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"
+ },
+ "LocationInfo": {
+ "description": "Detected entity location information.",
+ "type": "object",
+ "properties": {
+ "latLng": {
+ "$ref": "LatLng",
+ "description": "lat/long location coordinates."
+ }
+ },
+ "id": "LocationInfo"
},
"WebDetection": {
"description": "Relevant information for the image from the Internet.",
@@ -575,40 +655,10 @@
},
"id": "BatchAnnotateImagesResponse"
},
- "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"
- },
- "LocationInfo": {
- "properties": {
- "latLng": {
- "$ref": "LatLng",
- "description": "lat/long location coordinates."
- }
- },
- "id": "LocationInfo",
- "description": "Detected entity location information.",
- "type": "object"
- },
"Property": {
"description": "A `Property` consists of a user-supplied name/value pair.",
"type": "object",
"properties": {
- "value": {
- "description": "Value of the property.",
- "type": "string"
- },
"uint64Value": {
"description": "Value of numeric properties.",
"format": "uint64",
@@ -617,13 +667,15 @@
"name": {
"description": "Name of the property.",
"type": "string"
+ },
+ "value": {
+ "description": "Value of the property.",
+ "type": "string"
}
},
"id": "Property"
},
"Position": {
- "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.",
- "type": "object",
"properties": {
"y": {
"description": "Y coordinate.",
@@ -641,9 +693,13 @@
"type": "number"
}
},
- "id": "Position"
+ "id": "Position",
+ "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.",
+ "type": "object"
},
"ColorInfo": {
+ "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.",
+ "type": "object",
"properties": {
"score": {
"description": "Image-specific score for this color. Value in range [0, 1].",
@@ -660,11 +716,11 @@
"description": "RGB components of the color."
}
},
- "id": "ColorInfo",
- "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.",
- "type": "object"
+ "id": "ColorInfo"
},
"WebPage": {
+ "description": "Metadata for web pages.",
+ "type": "object",
"properties": {
"score": {
"description": "Overall relevancy score for the web page.\nNot normalized and not comparable across different image queries.",
@@ -676,14 +732,19 @@
"type": "string"
}
},
- "id": "WebPage",
- "description": "Metadata for web pages.",
- "type": "object"
+ "id": "WebPage"
},
"EntityAnnotation": {
"description": "Set of detected entity features.",
"type": "object",
"properties": {
+ "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"
+ }
+ },
"score": {
"description": "Overall score of the result. Range [0, 1].",
"format": "float",
@@ -706,8 +767,8 @@
"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."
+ "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.",
+ "$ref": "BoundingPoly"
},
"locale": {
"description": "The language code for the locale in which the entity textual\n`description` is expressed.",
@@ -721,13 +782,6 @@
"description": {
"description": "Entity textual description, expressed in its `locale` language.",
"type": "string"
- },
- "properties": {
- "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.",
- "type": "array",
- "items": {
- "$ref": "Property"
- }
}
},
"id": "EntityAnnotation"
@@ -754,49 +808,14 @@
"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": {
- "enum": [
- "UNKNOWN_LANDMARK",
- "LEFT_EYE",
- "RIGHT_EYE",
- "LEFT_OF_LEFT_EYEBROW",
- "RIGHT_OF_LEFT_EYEBROW",
- "LEFT_OF_RIGHT_EYEBROW",
- "RIGHT_OF_RIGHT_EYEBROW",
- "MIDPOINT_BETWEEN_EYES",
- "NOSE_TIP",
- "UPPER_LIP",
- "LOWER_LIP",
- "MOUTH_LEFT",
- "MOUTH_RIGHT",
- "MOUTH_CENTER",
- "NOSE_BOTTOM_RIGHT",
- "NOSE_BOTTOM_LEFT",
- "NOSE_BOTTOM_CENTER",
- "LEFT_EYE_TOP_BOUNDARY",
- "LEFT_EYE_RIGHT_CORNER",
- "LEFT_EYE_BOTTOM_BOUNDARY",
- "LEFT_EYE_LEFT_CORNER",
- "RIGHT_EYE_TOP_BOUNDARY",
- "RIGHT_EYE_RIGHT_CORNER",
- "RIGHT_EYE_BOTTOM_BOUNDARY",
- "RIGHT_EYE_LEFT_CORNER",
- "LEFT_EYEBROW_UPPER_MIDPOINT",
- "RIGHT_EYEBROW_UPPER_MIDPOINT",
- "LEFT_EAR_TRAGION",
- "RIGHT_EAR_TRAGION",
- "LEFT_EYE_PUPIL",
- "RIGHT_EYE_PUPIL",
- "FOREHEAD_GLABELLA",
- "CHIN_GNATHION",
- "CHIN_LEFT_GONION",
- "CHIN_RIGHT_GONION"
- ],
"description": "Face landmark type.",
"type": "string",
"enumDescriptions": [
@@ -835,14 +854,51 @@
"Chin gnathion.",
"Chin left gonion.",
"Chin right gonion."
+ ],
+ "enum": [
+ "UNKNOWN_LANDMARK",
+ "LEFT_EYE",
+ "RIGHT_EYE",
+ "LEFT_OF_LEFT_EYEBROW",
+ "RIGHT_OF_LEFT_EYEBROW",
+ "LEFT_OF_RIGHT_EYEBROW",
+ "RIGHT_OF_RIGHT_EYEBROW",
+ "MIDPOINT_BETWEEN_EYES",
+ "NOSE_TIP",
+ "UPPER_LIP",
+ "LOWER_LIP",
+ "MOUTH_LEFT",
+ "MOUTH_RIGHT",
+ "MOUTH_CENTER",
+ "NOSE_BOTTOM_RIGHT",
+ "NOSE_BOTTOM_LEFT",
+ "NOSE_BOTTOM_CENTER",
+ "LEFT_EYE_TOP_BOUNDARY",
+ "LEFT_EYE_RIGHT_CORNER",
+ "LEFT_EYE_BOTTOM_BOUNDARY",
+ "LEFT_EYE_LEFT_CORNER",
+ "RIGHT_EYE_TOP_BOUNDARY",
+ "RIGHT_EYE_RIGHT_CORNER",
+ "RIGHT_EYE_BOTTOM_BOUNDARY",
+ "RIGHT_EYE_LEFT_CORNER",
+ "LEFT_EYEBROW_UPPER_MIDPOINT",
+ "RIGHT_EYEBROW_UPPER_MIDPOINT",
+ "LEFT_EAR_TRAGION",
+ "RIGHT_EAR_TRAGION",
+ "LEFT_EYE_PUPIL",
+ "RIGHT_EYE_PUPIL",
+ "FOREHEAD_GLABELLA",
+ "CHIN_GNATHION",
+ "CHIN_LEFT_GONION",
+ "CHIN_RIGHT_GONION"
]
}
},
- "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`.",
- "type": "object"
+ "id": "Landmark"
},
"WebImage": {
+ "description": "Metadata for online images.",
+ "type": "object",
"properties": {
"score": {
"description": "Overall relevancy score for the image.\nNot normalized and not comparable across different image queries.",
@@ -854,28 +910,26 @@
"type": "string"
}
},
- "id": "WebImage",
- "description": "Metadata for online images.",
- "type": "object"
+ "id": "WebImage"
},
"Word": {
"description": "A word representation.",
"type": "object",
"properties": {
+ "property": {
+ "$ref": "TextProperty",
+ "description": "Additional information detected for the word."
+ },
+ "boundingBox": {
+ "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
+ "$ref": "BoundingPoly"
+ },
"symbols": {
"description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.",
"type": "array",
"items": {
"$ref": "Symbol"
}
- },
- "property": {
- "description": "Additional information detected for the word.",
- "$ref": "TextProperty"
- },
- "boundingBox": {
- "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
- "$ref": "BoundingPoly"
}
},
"id": "Word"
@@ -897,8 +951,6 @@
"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.",
@@ -916,15 +968,22 @@
}
}
},
- "id": "Paragraph"
+ "id": "Paragraph",
+ "description": "Structural unit of text representing a number of words in certain order.",
+ "type": "object"
},
"FaceAnnotation": {
- "description": "A face annotation object contains the results of face detection.",
- "type": "object",
"properties": {
+ "boundingPoly": {
+ "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated.",
+ "$ref": "BoundingPoly"
+ },
+ "rollAngle": {
+ "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].",
+ "format": "float",
+ "type": "number"
+ },
"sorrowLikelihood": {
- "description": "Sorrow likelihood.",
- "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -940,7 +999,9 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ]
+ ],
+ "description": "Sorrow likelihood.",
+ "type": "string"
},
"tiltAngle": {
"description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
@@ -1023,14 +1084,7 @@
"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"
- },
"underExposedLikelihood": {
- "description": "Under-exposed likelihood.",
- "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -1046,7 +1100,14 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ]
+ ],
+ "description": "Under-exposed likelihood.",
+ "type": "string"
+ },
+ "panAngle": {
+ "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].",
+ "format": "float",
+ "type": "number"
},
"detectionConfidence": {
"description": "Detection confidence. Range [0, 1].",
@@ -1054,8 +1115,6 @@
"type": "number"
},
"blurredLikelihood": {
- "description": "Blurred likelihood.",
- "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -1071,7 +1130,9 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ]
+ ],
+ "description": "Blurred likelihood.",
+ "type": "string"
},
"headwearLikelihood": {
"enumDescriptions": [
@@ -1092,22 +1153,13 @@
],
"description": "Headwear likelihood.",
"type": "string"
- },
- "boundingPoly": {
- "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated.",
- "$ref": "BoundingPoly"
- },
- "rollAngle": {
- "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].",
- "format": "float",
- "type": "number"
}
},
- "id": "FaceAnnotation"
+ "id": "FaceAnnotation",
+ "description": "A face annotation object contains the results of face detection.",
+ "type": "object"
},
"BatchAnnotateImagesRequest": {
- "description": "Multiple image annotation requests are batched into a single service call.",
- "type": "object",
"properties": {
"requests": {
"description": "Individual image annotation requests for this batch.",
@@ -1117,21 +1169,15 @@
}
}
},
- "id": "BatchAnnotateImagesRequest"
+ "id": "BatchAnnotateImagesRequest",
+ "description": "Multiple image annotation requests are batched into a single service call.",
+ "type": "object"
},
"DetectedBreak": {
"description": "Detected start or end of a structural component.",
"type": "object",
"properties": {
"type": {
- "enumDescriptions": [
- "Unknown break label type.",
- "Regular space.",
- "Sure space (very wide).",
- "Line-wrapping break.",
- "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.",
- "Line break that ends a paragraph."
- ],
"enum": [
"UNKNOWN",
"SPACE",
@@ -1141,7 +1187,15 @@
"LINE_BREAK"
],
"description": "Detected break type.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown break label type.",
+ "Regular space.",
+ "Sure space (very wide).",
+ "Line-wrapping break.",
+ "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.",
+ "Line break that ends a paragraph."
+ ]
},
"isPrefix": {
"description": "True if break prepends the element.",
@@ -1149,202 +1203,148 @@
}
},
"id": "DetectedBreak"
- },
- "ImageContext": {
- "description": "Image context and/or feature-specific parameters.",
- "type": "object",
- "properties": {
- "languageHints": {
- "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](/vision/docs/languages).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "latLongRect": {
- "$ref": "LatLongRect",
- "description": "lat/long rectangle that specifies the location of the image."
- },
- "cropHintsParams": {
- "description": "Parameters for crop hints annotation request.",
- "$ref": "CropHintsParams"
- }
- },
- "id": "ImageContext"
- },
- "Page": {
- "description": "Detected page from OCR.",
- "type": "object",
- "properties": {
- "height": {
- "description": "Page height in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "width": {
- "description": "Page width in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "blocks": {
- "description": "List of blocks of text, images etc on this page.",
- "type": "array",
- "items": {
- "$ref": "Block"
- }
- },
- "property": {
- "$ref": "TextProperty",
- "description": "Additional information detected on the page."
- }
- },
- "id": "Page"
- },
- "AnnotateImageRequest": {
- "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
- "type": "object",
- "properties": {
- "image": {
- "$ref": "Image",
- "description": "The image to be processed."
- },
- "features": {
- "description": "Requested features.",
- "type": "array",
- "items": {
- "$ref": "Feature"
- }
- },
- "imageContext": {
- "description": "Additional context that may accompany the image.",
- "$ref": "ImageContext"
- }
- },
- "id": "AnnotateImageRequest"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` 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"
- },
- "LatLongRect": {
- "properties": {
- "minLatLng": {
- "description": "Min lat/long pair.",
- "$ref": "LatLng"
- },
- "maxLatLng": {
- "$ref": "LatLng",
- "description": "Max lat/long pair."
- }
- },
- "id": "LatLongRect",
- "description": "Rectangle determined by min and max `LatLng` pairs.",
- "type": "object"
- },
- "Symbol": {
- "description": "A single symbol representation.",
- "type": "object",
- "properties": {
- "text": {
- "description": "The actual UTF-8 representation of the symbol.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "Symbol"
- },
- "CropHintsAnnotation": {
- "properties": {
- "cropHints": {
- "description": "Crop hint results.",
- "type": "array",
- "items": {
- "$ref": "CropHint"
- }
- }
- },
- "id": "CropHintsAnnotation",
- "description": "Set of crop hints that are used to generate new crops when serving images.",
- "type": "object"
- },
- "LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)\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"
- },
- "Color": {
- "properties": {
- "red": {
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "green": {
- "description": "The amount of green in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "blue": {
- "description": "The amount of blue in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
- "alpha": {
- "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
- "format": "float",
- "type": "number"
- }
- },
- "id": "Color",
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
- "type": "object"
}
},
+ "protocol": "rest",
"icons": {
"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": "Vision",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://vision.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "vision",
+ "batchPath": "batch",
+ "title": "Google Cloud Vision API",
+ "ownerName": "Google",
+ "resources": {
+ "images": {
+ "methods": {
+ "annotate": {
+ "flatPath": "v1/images:annotate",
+ "id": "vision.images.annotate",
+ "path": "v1/images:annotate",
+ "request": {
+ "$ref": "BatchAnnotateImagesRequest"
+ },
+ "description": "Run image detection and annotation for a batch of images.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "BatchAnnotateImagesResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ },
+ "parameters": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "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": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://vision.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "vision:v1",
+ "revision": "20170523",
+ "documentationLink": "https://cloud.google.com/vision/"
}
diff --git a/vision/v1/vision-gen.go b/vision/v1/vision-gen.go
index af42a8c..7af1c74 100644
--- a/vision/v1/vision-gen.go
+++ b/vision/v1/vision-gen.go
@@ -1504,10 +1504,6 @@
// 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].
@@ -1917,7 +1913,7 @@
// 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
+// in the package `google.rpc` that can be used for common error
// conditions.
//
// # Language mapping
@@ -1950,7 +1946,7 @@
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
-// have a `Status` message for error reporting purpose.
+// have a `Status` message for error reporting.
//
// - Batch operations. If a client uses batch request and batch
// response, the
diff --git a/youtubereporting/v1/youtubereporting-api.json b/youtubereporting/v1/youtubereporting-api.json
index 31a9e0a..e50aa7d 100644
--- a/youtubereporting/v1/youtubereporting-api.json
+++ b/youtubereporting/v1/youtubereporting-api.json
@@ -1,8 +1,65 @@
{
+ "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",
+ "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
+ "id": "youtubereporting:v1",
+ "revision": "20170531",
+ "title": "YouTube Reporting API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
+ "reportTypes": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListReportTypesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListReportTypes` method.",
+ "type": "string",
+ "location": "query"
+ },
+ "includeSystemManaged": {
+ "location": "query",
+ "description": "If set to true, also system-managed report types will be returned;\notherwise only the report types that can be used to create new reporting\njobs will be returned.",
+ "type": "boolean"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "onBehalfOfContentOwner": {
+ "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",
+ "path": "v1/reportTypes",
+ "id": "youtubereporting.reportTypes.list",
+ "description": "Lists report types."
+ }
+ }
+ },
"media": {
"methods": {
"download": {
+ "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.",
"supportsMediaDownload": true,
"response": {
"$ref": "Media"
@@ -26,46 +83,25 @@
],
"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`."
+ "id": "youtubereporting.media.download"
}
}
},
"jobs": {
"methods": {
- "create": {
- "flatPath": "v1/jobs",
- "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": {
- "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)."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ]
- },
"delete": {
- "httpMethod": "DELETE",
+ "description": "Deletes a job.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"jobId"
],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
"parameters": {
"jobId": {
"description": "The ID of the job to delete.",
@@ -74,86 +110,106 @@
"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"
+ "type": "string",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
"flatPath": "v1/jobs/{jobId}",
- "id": "youtubereporting.jobs.delete",
"path": "v1/jobs/{jobId}",
- "description": "Deletes a job."
+ "id": "youtubereporting.jobs.delete"
},
"list": {
+ "description": "Lists jobs.",
"response": {
"$ref": "ListJobsResponse"
},
- "httpMethod": "GET",
"parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
"parameters": {
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- },
"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 `ListJobs` method.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"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": {
- "type": "integer",
- "location": "query",
"description": "Requested page size. Server may return fewer jobs than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "onBehalfOfContentOwner": {
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
"flatPath": "v1/jobs",
"path": "v1/jobs",
- "id": "youtubereporting.jobs.list",
- "description": "Lists jobs."
+ "id": "youtubereporting.jobs.list"
},
"get": {
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "jobId"
],
+ "httpMethod": "GET",
"parameters": {
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- },
"jobId": {
"location": "path",
"description": "The ID of the job to retrieve.",
"required": true,
"type": "string"
+ },
+ "onBehalfOfContentOwner": {
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string",
+ "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
"flatPath": "v1/jobs/{jobId}",
"path": "v1/jobs/{jobId}",
"id": "youtubereporting.jobs.get",
- "description": "Gets a job.",
- "parameterOrder": [
- "jobId"
- ],
- "httpMethod": "GET",
+ "description": "Gets a job."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Job"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "parameters": {
+ "onBehalfOfContentOwner": {
+ "location": "query",
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/jobs",
+ "id": "youtubereporting.jobs.create",
+ "path": "v1/jobs",
+ "description": "Creates a job and returns it.",
+ "request": {
+ "$ref": "Job"
}
}
},
@@ -161,26 +217,33 @@
"reports": {
"methods": {
"list": {
+ "flatPath": "v1/jobs/{jobId}/reports",
"path": "v1/jobs/{jobId}/reports",
"id": "youtubereporting.jobs.reports.list",
"description": "Lists reports created by a specific job.\nReturns NOT_FOUND if the job does not exist.",
- "response": {
- "$ref": "ListReportsResponse"
- },
"parameterOrder": [
"jobId"
],
+ "response": {
+ "$ref": "ListReportsResponse"
+ },
"httpMethod": "GET",
"parameters": {
- "createdAfter": {
+ "startTimeBefore": {
"location": "query",
- "description": "If set, only reports created after the specified date/time are returned.",
+ "description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned.",
"format": "google-datetime",
"type": "string"
},
- "startTimeAtOrAfter": {
+ "jobId": {
+ "location": "path",
+ "description": "The ID of the job.",
+ "required": true,
+ "type": "string"
+ },
+ "createdAfter": {
"location": "query",
- "description": "If set, only reports whose start time is greater than or equal the\nspecified date/time are returned.",
+ "description": "If set, only reports created after the specified date/time are returned.",
"format": "google-datetime",
"type": "string"
},
@@ -189,35 +252,28 @@
"description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportsResponse.next_page_token\nreturned in response to the previous call to the `ListReports` method.",
"type": "string"
},
- "pageSize": {
- "type": "integer",
+ "startTimeAtOrAfter": {
"location": "query",
+ "description": "If set, only reports whose start time is greater than or equal the\nspecified date/time are returned.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageSize": {
"description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
},
"onBehalfOfContentOwner": {
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
"type": "string",
"location": "query"
- },
- "startTimeBefore": {
- "type": "string",
- "location": "query",
- "description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned.",
- "format": "google-datetime"
- },
- "jobId": {
- "description": "The ID of the job.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "flatPath": "v1/jobs/{jobId}/reports"
+ ]
},
"get": {
"description": "Gets the metadata of a specific report.",
@@ -231,15 +287,15 @@
},
"parameters": {
"jobId": {
- "required": true,
- "type": "string",
"location": "path",
- "description": "The ID of the job."
+ "description": "The ID of the job.",
+ "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": "query"
},
"reportId": {
"location": "path",
@@ -259,57 +315,12 @@
}
}
}
- },
- "reportTypes": {
- "methods": {
- "list": {
- "flatPath": "v1/reportTypes",
- "id": "youtubereporting.reportTypes.list",
- "path": "v1/reportTypes",
- "description": "Lists report types.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListReportTypesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "parameters": {
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- },
- "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"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- }
- }
- }
}
},
"parameters": {
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -318,17 +329,14 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -336,17 +344,23 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string"
},
"key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"location": "query",
@@ -354,21 +368,21 @@
"type": "string"
},
"pp": {
+ "description": "Pretty-print response.",
"type": "boolean",
"default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
+ "location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -386,16 +400,49 @@
"location": "query"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
"schemas": {
+ "Media": {
+ "description": "Media resource.",
+ "type": "object",
+ "properties": {
+ "resourceName": {
+ "description": "Name of the media resource.",
+ "type": "string"
+ }
+ },
+ "id": "Media"
+ },
"Report": {
"description": "A report's metadata including the URL from which the report itself can be\ndownloaded.",
"type": "object",
"properties": {
+ "jobId": {
+ "description": "The ID of the job that created this report.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated ID of the report.",
+ "type": "string"
+ },
+ "jobExpireTime": {
+ "description": "The date/time when the job this report belongs to will expire/expired.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The end of the time period that the report instance covers. The value is\nexclusive.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "downloadUrl": {
+ "description": "The URL from which the report can be downloaded (max. 1000 characters).",
+ "type": "string"
+ },
"startTime": {
"description": "The start of the time period that the report instance covers. The value is\ninclusive.",
"format": "google-datetime",
@@ -405,37 +452,15 @@
"description": "The date/time when this report was created.",
"format": "google-datetime",
"type": "string"
- },
- "jobId": {
- "type": "string",
- "description": "The ID of the job that created this report."
- },
- "id": {
- "description": "The server-generated ID of the report.",
- "type": "string"
- },
- "endTime": {
- "description": "The end of the time period that the report instance covers. The value is\nexclusive.",
- "format": "google-datetime",
- "type": "string"
- },
- "jobExpireTime": {
- "description": "The date/time when the job this report belongs to will expire/expired.",
- "format": "google-datetime",
- "type": "string"
- },
- "downloadUrl": {
- "type": "string",
- "description": "The URL from which the report can be downloaded (max. 1000 characters)."
}
},
"id": "Report"
},
"Empty": {
- "id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "Empty"
},
"ListReportTypesResponse": {
"description": "Response message for ReportingService.ListReportTypes.",
@@ -456,8 +481,14 @@
"id": "ListReportTypesResponse"
},
"ReportType": {
+ "description": "A report type.",
"type": "object",
"properties": {
+ "deprecateTime": {
+ "description": "The date/time when this report type was/will be deprecated.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"name": {
"description": "The name of the report type (max. 100 characters).",
"type": "string"
@@ -469,17 +500,13 @@
"systemManaged": {
"description": "True if this a system-managed report type; otherwise false. Reporting jobs\nfor system-managed report types are created automatically and can thus not\nbe used in the `CreateJob` method.",
"type": "boolean"
- },
- "deprecateTime": {
- "description": "The date/time when this report type was/will be deprecated.",
- "format": "google-datetime",
- "type": "string"
}
},
- "id": "ReportType",
- "description": "A report type."
+ "id": "ReportType"
},
"ListJobsResponse": {
+ "description": "Response message for ReportingService.ListJobs.",
+ "type": "object",
"properties": {
"jobs": {
"description": "The list of jobs.",
@@ -493,45 +520,42 @@
"type": "string"
}
},
- "id": "ListJobsResponse",
- "description": "Response message for ReportingService.ListJobs.",
- "type": "object"
+ "id": "ListJobsResponse"
},
"Job": {
"description": "A job creating reports of a specific type.",
"type": "object",
"properties": {
- "systemManaged": {
- "description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.",
- "type": "boolean"
- },
- "id": {
- "description": "The server-generated ID of the job (max. 40 characters).",
- "type": "string"
- },
"createTime": {
"description": "The creation date/time of the job.",
"format": "google-datetime",
"type": "string"
},
- "expireTime": {
- "description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
- "format": "google-datetime",
- "type": "string"
- },
"reportTypeId": {
"description": "The type of reports this job creates. Corresponds to the ID of a\nReportType.",
"type": "string"
},
+ "expireTime": {
+ "description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"name": {
"description": "The name of the job (max. 100 characters).",
"type": "string"
+ },
+ "id": {
+ "description": "The server-generated ID of the job (max. 40 characters).",
+ "type": "string"
+ },
+ "systemManaged": {
+ "description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.",
+ "type": "boolean"
}
},
"id": "Job"
},
"ListReportsResponse": {
- "id": "ListReportsResponse",
"description": "Response message for ReportingService.ListReports.",
"type": "object",
"properties": {
@@ -546,18 +570,8 @@
"$ref": "Report"
}
}
- }
- },
- "Media": {
- "id": "Media",
- "description": "Media resource.",
- "type": "object",
- "properties": {
- "resourceName": {
- "description": "Name of the media resource.",
- "type": "string"
- }
- }
+ },
+ "id": "ListReportsResponse"
}
},
"icons": {
@@ -579,19 +593,5 @@
}
}
}
- },
- "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.",
- "rootUrl": "https://youtubereporting.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "youtubereporting",
- "batchPath": "batch",
- "id": "youtubereporting:v1",
- "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
- "revision": "20170508",
- "title": "YouTube Reporting API",
- "ownerName": "Google",
- "discoveryVersion": "v1"
+ }
}
